PySide6.QtOpenGL.QOpenGLPixelTransferOptions¶

class QOpenGLPixelTransferOptions¶

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

Synopsis¶

Methods¶

def __init__()
def alignment()
def imageHeight()
def isLeastSignificantBitFirst()
def isSwapBytesEnabled()
def rowLength()
def setAlignment()
def setImageHeight()
def setLeastSignificantByteFirst()
def setRowLength()
def setSkipImages()
def setSkipPixels()
def setSkipRows()
def setSwapBytesEnabled()
def skipImages()
def skipPixels()
def skipRows()
def swap()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()¶

Constructs a new QOpenGLPixelTransferOptions instance with the default settings.

__init__(arg__1)

Parameters:: arg__1 – QOpenGLPixelTransferOptions

alignment()¶

Return type:: int

Returns the current alignment requirement for each pixel row.

See also

setAlignment()

imageHeight()¶

Return type:: int

Returns the currently set image height.

See also

setImageHeight()

isLeastSignificantBitFirst()¶

Return type:: bool

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

isSwapBytesEnabled()¶

Return type:: bool

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

rowLength()¶

Return type:: int

Returns the currently set row length.

See also

setRowLength()

setAlignment(alignment)¶

Parameters:: alignment – int

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()

setImageHeight(imageHeight)¶

Parameters:: imageHeight – int

Sets the image height for 3D textures to imageHeight. Corresponds to GL_UNPACK_IMAGE_HEIGHT. The default value is 0.

See also

imageHeight()

setLeastSignificantByteFirst(lsbFirst)¶

Parameters:: lsbFirst – bool

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.

setRowLength(rowLength)¶

Parameters:: rowLength – int

Sets the number of pixels in a row to rowLength. Corresponds to GL_UNPACK_ROW_LENGTH. The default value is 0.

See also

rowLength()

setSkipImages(skipImages)¶

Parameters:: skipImages – int

Sets the number of images that are skipped to skipImages. Corresponds to GL_UNPACK_SKIP_IMAGES. Equivalent to incrementing the pointer passed to setData() . The default value is 0.

See also

skipImages()

setSkipPixels(skipPixels)¶

Parameters:: skipPixels – int

Sets the number of pixels that are skipped to skipPixels. Corresponds to GL_UNPACK_SKIP_PIXELS. Equivalent to incrementing the pointer passed to setData() . The default value is 0.

See also

skipPixels()

setSkipRows(skipRows)¶

Parameters:: skipRows – int

Sets the number of rows that are skipped to skipRows. Corresponds to GL_UNPACK_SKIP_ROWS. Equivalent to incrementing the pointer passed to setData() . The default value is 0.

See also

skipRows()

setSwapBytesEnabled(swapBytes)¶

Parameters:: swapBytes – bool

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()

skipImages()¶

Return type:: int

Returns the number of images that are skipped.

See also

setSkipImages()

skipPixels()¶

Return type:: int

Returns the number of pixels that are skipped.

See also

setSkipPixels()

skipRows()¶

Return type:: int

Returns the number of rows that are skipped.

See also

setSkipRows()

swap(other)¶

Parameters:: other – QOpenGLPixelTransferOptions

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