Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QOpenGLPixelTransferOptions Class Reference

\inmodule QtOpenGL More...

#include <qopenglpixeltransferoptions.h>

+ Collaboration diagram for QOpenGLPixelTransferOptions:

Public Member Functions

 QOpenGLPixelTransferOptions ()
 Constructs a new QOpenGLPixelTransferOptions instance with the default settings.
 
 QOpenGLPixelTransferOptions (const QOpenGLPixelTransferOptions &)
 
QOpenGLPixelTransferOptionsoperator= (const QOpenGLPixelTransferOptions &)
 
 ~QOpenGLPixelTransferOptions ()
 Destructor.
 
void swap (QOpenGLPixelTransferOptions &other) noexcept
 
void setAlignment (int alignment)
 Sets the alignment requirements for each pixel row.
 
int alignment () const
 
void setSkipImages (int skipImages)
 Sets the number of images that are skipped to skipImages.
 
int skipImages () const
 
void setSkipRows (int skipRows)
 Sets the number of rows that are skipped to skipRows.
 
int skipRows () const
 
void setSkipPixels (int skipPixels)
 Sets the number of pixels that are skipped to skipPixels.
 
int skipPixels () const
 
void setImageHeight (int imageHeight)
 Sets the image height for 3D textures to imageHeight.
 
int imageHeight () const
 
void setRowLength (int rowLength)
 Sets the number of pixels in a row to rowLength.
 
int rowLength () const
 
void setLeastSignificantByteFirst (bool lsbFirst)
 lsbFirst specifies if bits within a byte are ordered from least to most significat.
 
bool isLeastSignificantBitFirst () const
 
void setSwapBytesEnabled (bool swapBytes)
 swapBytes specifies if the byte ordering for multibyte components is reversed.
 
bool isSwapBytesEnabled () const
 

Detailed Description

\inmodule QtOpenGL

The QOpenGLPixelTransferOptions class describes the pixel storage modes that affect the unpacking of pixels during texture upload.

Definition at line 17 of file qopenglpixeltransferoptions.h.

Constructor & Destructor Documentation

◆ QOpenGLPixelTransferOptions() [1/2]

QOpenGLPixelTransferOptions::QOpenGLPixelTransferOptions ( )

Constructs a new QOpenGLPixelTransferOptions instance with the default settings.

Definition at line 54 of file qopenglpixeltransferoptions.cpp.

◆ QOpenGLPixelTransferOptions() [2/2]

QOpenGLPixelTransferOptions::QOpenGLPixelTransferOptions ( const QOpenGLPixelTransferOptions & rhs)

Definition at line 62 of file qopenglpixeltransferoptions.cpp.

◆ ~QOpenGLPixelTransferOptions()

QOpenGLPixelTransferOptions::~QOpenGLPixelTransferOptions ( )

Destructor.

Definition at line 80 of file qopenglpixeltransferoptions.cpp.

Member Function Documentation

◆ alignment()

int QOpenGLPixelTransferOptions::alignment ( ) const
Returns
the current alignment requirement for each pixel row.

Definition at line 96 of file qopenglpixeltransferoptions.cpp.

Referenced by setAlignment(), and QOpenGLTextureHelper::setPixelUploadOptions().

+ Here is the caller graph for this function:

◆ imageHeight()

int QOpenGLPixelTransferOptions::imageHeight ( ) const
Returns
the currently set image height.

Definition at line 168 of file qopenglpixeltransferoptions.cpp.

Referenced by setImageHeight(), and QOpenGLTextureHelper::setPixelUploadOptions().

+ Here is the caller graph for this function:

◆ isLeastSignificantBitFirst()

bool QOpenGLPixelTransferOptions::isLeastSignificantBitFirst ( ) const
Returns
true if bits within a byte are ordered from least to most significant.

Definition at line 205 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::setPixelUploadOptions().

+ Here is the caller graph for this function:

◆ isSwapBytesEnabled()

bool QOpenGLPixelTransferOptions::isSwapBytesEnabled ( ) const
Returns
true if the byte ordering for multibyte components is reversed.

Definition at line 223 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::setPixelUploadOptions().

+ Here is the caller graph for this function:

◆ operator=()

QOpenGLPixelTransferOptions & QOpenGLPixelTransferOptions::operator= ( const QOpenGLPixelTransferOptions & rhs)

Definition at line 70 of file qopenglpixeltransferoptions.cpp.

◆ rowLength()

int QOpenGLPixelTransferOptions::rowLength ( ) const
Returns
the currently set row length.

Definition at line 186 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::setPixelUploadOptions(), and setRowLength().

+ Here is the caller graph for this function:

◆ setAlignment()

void QOpenGLPixelTransferOptions::setAlignment ( int alignment)

Sets the alignment requirements for each pixel row.

Corresponds to GL_UNPACK_ALIGNMENT. The default value is 4, as specified by OpenGL.

Definition at line 88 of file qopenglpixeltransferoptions.cpp.

References alignment().

Referenced by QOpenGLTextureHelper::savePixelUploadOptions(), and QOpenGLTexture::setData().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setImageHeight()

void QOpenGLPixelTransferOptions::setImageHeight ( int imageHeight)

Sets the image height for 3D textures to imageHeight.

Corresponds to GL_UNPACK_IMAGE_HEIGHT. The default value is 0.

Definition at line 160 of file qopenglpixeltransferoptions.cpp.

References imageHeight().

Referenced by QOpenGLTextureHelper::savePixelUploadOptions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setLeastSignificantByteFirst()

void QOpenGLPixelTransferOptions::setLeastSignificantByteFirst ( bool lsbFirst)

lsbFirst specifies if bits within a byte are ordered from least to most significat.

The default value is false, meaning that the first bit in each byte is the most significant one. This is significant for bitmap data only. Corresponds to GL_UNPACK_LSB_FIRST.

Definition at line 197 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::savePixelUploadOptions().

+ Here is the caller graph for this function:

◆ setRowLength()

void QOpenGLPixelTransferOptions::setRowLength ( int rowLength)

Sets the number of pixels in a row to rowLength.

Corresponds to GL_UNPACK_ROW_LENGTH. The default value is 0.

Definition at line 178 of file qopenglpixeltransferoptions.cpp.

References rowLength().

Referenced by QOpenGLTextureHelper::savePixelUploadOptions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSkipImages()

void QOpenGLPixelTransferOptions::setSkipImages ( int skipImages)

Sets the number of images that are skipped to skipImages.

Corresponds to GL_UNPACK_SKIP_IMAGES. Equivalent to incrementing the pointer passed to QOpenGLTexture::setData(). The default value is 0.

Definition at line 106 of file qopenglpixeltransferoptions.cpp.

References skipImages().

Referenced by QOpenGLTextureHelper::savePixelUploadOptions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSkipPixels()

void QOpenGLPixelTransferOptions::setSkipPixels ( int skipPixels)

Sets the number of pixels that are skipped to skipPixels.

Corresponds to GL_UNPACK_SKIP_PIXELS. Equivalent to incrementing the pointer passed to QOpenGLTexture::setData(). The default value is 0.

Definition at line 142 of file qopenglpixeltransferoptions.cpp.

References skipPixels().

Referenced by QOpenGLTextureHelper::savePixelUploadOptions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSkipRows()

void QOpenGLPixelTransferOptions::setSkipRows ( int skipRows)

Sets the number of rows that are skipped to skipRows.

Corresponds to GL_UNPACK_SKIP_ROWS. Equivalent to incrementing the pointer passed to QOpenGLTexture::setData(). The default value is 0.

Definition at line 124 of file qopenglpixeltransferoptions.cpp.

References skipRows().

Referenced by QOpenGLTextureHelper::savePixelUploadOptions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSwapBytesEnabled()

void QOpenGLPixelTransferOptions::setSwapBytesEnabled ( bool swapBytes)

swapBytes specifies if the byte ordering for multibyte components is reversed.

The default value is false. Corresponds to GL_UNPACK_SWAP_BYTES.

Definition at line 215 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::savePixelUploadOptions().

+ Here is the caller graph for this function:

◆ skipImages()

int QOpenGLPixelTransferOptions::skipImages ( ) const
Returns
the number of images that are skipped.

Definition at line 114 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::setPixelUploadOptions(), and setSkipImages().

+ Here is the caller graph for this function:

◆ skipPixels()

int QOpenGLPixelTransferOptions::skipPixels ( ) const
Returns
the number of pixels that are skipped.

Definition at line 150 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::setPixelUploadOptions(), and setSkipPixels().

+ Here is the caller graph for this function:

◆ skipRows()

int QOpenGLPixelTransferOptions::skipRows ( ) const
Returns
the number of rows that are skipped.

Definition at line 132 of file qopenglpixeltransferoptions.cpp.

Referenced by QOpenGLTextureHelper::setPixelUploadOptions(), and setSkipRows().

+ Here is the caller graph for this function:

◆ swap()

void QOpenGLPixelTransferOptions::swap ( QOpenGLPixelTransferOptions & other)
inlinenoexcept

Definition at line 26 of file qopenglpixeltransferoptions.h.

References other().

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: