QOpenGLPixelTransferOptions Class | Qt OpenGL
Description: The QOpenGLPixelTransferOptions class describes the pixel storage modes that affect the unpacking of pixels during texture upload.

- Qt 6.11
- Qt OpenGL
- C++ Classes
- QOpenGLPixelTransferOptions
- Qt 6.11.2 Reference Documentation

# QOpenGLPixelTransferOptions Class

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

Header: | `#include <QOpenGLPixelTransferOptions>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS OpenGL)` `target_link_libraries(mytarget PRIVATE Qt6::OpenGL)`
qmake: | `QT += opengl`

- List of all members, including inherited members

## Public Functions

| QOpenGLPixelTransferOptions()
| ~QOpenGLPixelTransferOptions()
int | alignment() const
int | imageHeight() const
bool | isLeastSignificantBitFirst() const
bool | isSwapBytesEnabled() const
int | rowLength() const
void | setAlignment(int alignment)
void | setImageHeight(int imageHeight)
void | setLeastSignificantByteFirst(bool lsbFirst)
void | setRowLength(int rowLength)
void | setSkipImages(int skipImages)
void | setSkipPixels(int skipPixels)
void | setSkipRows(int skipRows)
void | setSwapBytesEnabled(bool swapBytes)
int | skipImages() const
int | skipPixels() const
int | skipRows() const
void | swap(QOpenGLPixelTransferOptions &other)

## Detailed Description

## Member Function Documentation

### QOpenGLPixelTransferOptions::QOpenGLPixelTransferOptions()

Constructs a new QOpenGLPixelTransferOptions instance with the default settings.

### `[noexcept]` QOpenGLPixelTransferOptions::~QOpenGLPixelTransferOptions()

Destructor.

### int QOpenGLPixelTransferOptions::alignment() const

Returns the current alignment requirement for each pixel row.

See also setAlignment().

### int QOpenGLPixelTransferOptions::imageHeight() const

Returns the currently set image height.

See also setImageHeight().

### bool QOpenGLPixelTransferOptions::isLeastSignificantBitFirst() const

Returns `true` if bits within a byte are ordered from least to most significant.

### bool QOpenGLPixelTransferOptions::isSwapBytesEnabled() const

Returns `true` if the byte ordering for multibyte components is reversed.

### int QOpenGLPixelTransferOptions::rowLength() const

Returns the currently set row length.

See also setRowLength().

### 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.

See also alignment().

### 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.

See also imageHeight().

### 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`.

### 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.

See also rowLength().

### 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.

See also skipImages().

### 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.

See also skipPixels().

### 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.

See also skipRows().

### 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`.

See also isSwapBytesEnabled().

### int QOpenGLPixelTransferOptions::skipImages() const

Returns the number of images that are skipped.

See also setSkipImages().

### int QOpenGLPixelTransferOptions::skipPixels() const

Returns the number of pixels that are skipped.

See also setSkipPixels().

### int QOpenGLPixelTransferOptions::skipRows() const

Returns the number of rows that are skipped.

See also setSkipRows().

### `[noexcept]` void QOpenGLPixelTransferOptions::swap(QOpenGLPixelTransferOptions &other)

Swaps this options with other. This operation is very fast and never fails.