<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qopenglpixeltransferoptions.cpp --> <title>QOpenGLPixelTransferOptions Class | Qt GUI 5.12.2</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.12</td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QOpenGLPixelTransferOptions</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtgui-index.html">Qt 5.12.2 Reference Documentation</a></td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QOpenGLPixelTransferOptions Class</h1> <!-- $$$QOpenGLPixelTransferOptions-brief --> <p>The <a href="qopenglpixeltransferoptions.html">QOpenGLPixelTransferOptions</a> class describes the pixel storage modes that affect the unpacking of pixels during texture upload. <a href="#details">More...</a></p> <!-- @@@QOpenGLPixelTransferOptions --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QOpenGLPixelTransferOptions></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr></table></div><ul> <li><a href="qopenglpixeltransferoptions-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#QOpenGLPixelTransferOptions">QOpenGLPixelTransferOptions</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#dtor.QOpenGLPixelTransferOptions">~QOpenGLPixelTransferOptions</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#alignment">alignment</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#imageHeight">imageHeight</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#isLeastSignificantBitFirst">isLeastSignificantBitFirst</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#isSwapBytesEnabled">isSwapBytesEnabled</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#rowLength">rowLength</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setAlignment">setAlignment</a></b>(int <i>alignment</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setImageHeight">setImageHeight</a></b>(int <i>imageHeight</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setLeastSignificantByteFirst">setLeastSignificantByteFirst</a></b>(bool <i>lsbFirst</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setRowLength">setRowLength</a></b>(int <i>rowLength</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setSkipImages">setSkipImages</a></b>(int <i>skipImages</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setSkipPixels">setSkipPixels</a></b>(int <i>skipPixels</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setSkipRows">setSkipRows</a></b>(int <i>skipRows</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#setSwapBytesEnabled">setSwapBytesEnabled</a></b>(bool <i>swapBytes</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#skipImages">skipImages</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#skipPixels">skipPixels</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qopenglpixeltransferoptions.html#skipRows">skipRows</a></b>() const</td></tr> </table></div> <a name="details"></a> <!-- $$$QOpenGLPixelTransferOptions-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qopenglpixeltransferoptions.html">QOpenGLPixelTransferOptions</a> class describes the pixel storage modes that affect the unpacking of pixels during texture upload.</p> </div> <!-- @@@QOpenGLPixelTransferOptions --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QOpenGLPixelTransferOptions[overload1]$$$QOpenGLPixelTransferOptions --> <h3 class="fn" id="QOpenGLPixelTransferOptions"><a name="QOpenGLPixelTransferOptions"></a>QOpenGLPixelTransferOptions::<span class="name">QOpenGLPixelTransferOptions</span>()</h3> <p>Constructs a new <a href="qopenglpixeltransferoptions.html">QOpenGLPixelTransferOptions</a> instance with the default settings.</p> <!-- @@@QOpenGLPixelTransferOptions --> <!-- $$$~QOpenGLPixelTransferOptions[overload1]$$$~QOpenGLPixelTransferOptions --> <h3 class="fn" id="dtor.QOpenGLPixelTransferOptions"><a name="dtor.QOpenGLPixelTransferOptions"></a>QOpenGLPixelTransferOptions::<span class="name">~QOpenGLPixelTransferOptions</span>()</h3> <p>Destructor.</p> <!-- @@@~QOpenGLPixelTransferOptions --> <!-- $$$alignment[overload1]$$$alignment --> <h3 class="fn" id="alignment"><a name="alignment"></a><span class="type">int</span> QOpenGLPixelTransferOptions::<span class="name">alignment</span>() const</h3> <p>Returns the current alignment requirement for each pixel row.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#setAlignment">setAlignment</a>().</p> <!-- @@@alignment --> <!-- $$$imageHeight[overload1]$$$imageHeight --> <h3 class="fn" id="imageHeight"><a name="imageHeight"></a><span class="type">int</span> QOpenGLPixelTransferOptions::<span class="name">imageHeight</span>() const</h3> <p>Returns the currently set image height.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#setImageHeight">setImageHeight</a>().</p> <!-- @@@imageHeight --> <!-- $$$isLeastSignificantBitFirst[overload1]$$$isLeastSignificantBitFirst --> <h3 class="fn" id="isLeastSignificantBitFirst"><a name="isLeastSignificantBitFirst"></a><span class="type">bool</span> QOpenGLPixelTransferOptions::<span class="name">isLeastSignificantBitFirst</span>() const</h3> <p>Returns <code>true</code> if bits within a byte are ordered from least to most significant.</p> <!-- @@@isLeastSignificantBitFirst --> <!-- $$$isSwapBytesEnabled[overload1]$$$isSwapBytesEnabled --> <h3 class="fn" id="isSwapBytesEnabled"><a name="isSwapBytesEnabled"></a><span class="type">bool</span> QOpenGLPixelTransferOptions::<span class="name">isSwapBytesEnabled</span>() const</h3> <p>Returns <code>true</code> if the byte ordering for multibyte components is reversed.</p> <!-- @@@isSwapBytesEnabled --> <!-- $$$rowLength[overload1]$$$rowLength --> <h3 class="fn" id="rowLength"><a name="rowLength"></a><span class="type">int</span> QOpenGLPixelTransferOptions::<span class="name">rowLength</span>() const</h3> <p>Returns the currently set row length.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#setRowLength">setRowLength</a>().</p> <!-- @@@rowLength --> <!-- $$$setAlignment[overload1]$$$setAlignmentint --> <h3 class="fn" id="setAlignment"><a name="setAlignment"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setAlignment</span>(<span class="type">int</span> <i>alignment</i>)</h3> <p>Sets the <i>alignment</i> requirements for each pixel row. Corresponds to <code>GL_UNPACK_ALIGNMENT</code>. The default value is 4, as specified by OpenGL.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#alignment">alignment</a>().</p> <!-- @@@setAlignment --> <!-- $$$setImageHeight[overload1]$$$setImageHeightint --> <h3 class="fn" id="setImageHeight"><a name="setImageHeight"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setImageHeight</span>(<span class="type">int</span> <i>imageHeight</i>)</h3> <p>Sets the image height for 3D textures to <i>imageHeight</i>. Corresponds to <code>GL_UNPACK_IMAGE_HEIGHT</code>. The default value is 0.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#imageHeight">imageHeight</a>().</p> <!-- @@@setImageHeight --> <!-- $$$setLeastSignificantByteFirst[overload1]$$$setLeastSignificantByteFirstbool --> <h3 class="fn" id="setLeastSignificantByteFirst"><a name="setLeastSignificantByteFirst"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setLeastSignificantByteFirst</span>(<span class="type">bool</span> <i>lsbFirst</i>)</h3> <p><i>lsbFirst</i> specifies if bits within a byte are ordered from least to most significat. The default value is <code>false</code>, meaning that the first bit in each byte is the most significant one. This is significant for bitmap data only. Corresponds to <code>GL_UNPACK_LSB_FIRST</code>.</p> <!-- @@@setLeastSignificantByteFirst --> <!-- $$$setRowLength[overload1]$$$setRowLengthint --> <h3 class="fn" id="setRowLength"><a name="setRowLength"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setRowLength</span>(<span class="type">int</span> <i>rowLength</i>)</h3> <p>Sets the number of pixels in a row to <i>rowLength</i>. Corresponds to <code>GL_UNPACK_ROW_LENGTH</code>. The default value is 0.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#rowLength">rowLength</a>().</p> <!-- @@@setRowLength --> <!-- $$$setSkipImages[overload1]$$$setSkipImagesint --> <h3 class="fn" id="setSkipImages"><a name="setSkipImages"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setSkipImages</span>(<span class="type">int</span> <i>skipImages</i>)</h3> <p>Sets the number of images that are skipped to <i>skipImages</i>. Corresponds to <code>GL_UNPACK_SKIP_IMAGES</code>. Equivalent to incrementing the pointer passed to <a href="qopengltexture.html#setData">QOpenGLTexture::setData</a>(). The default value is 0.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#skipImages">skipImages</a>().</p> <!-- @@@setSkipImages --> <!-- $$$setSkipPixels[overload1]$$$setSkipPixelsint --> <h3 class="fn" id="setSkipPixels"><a name="setSkipPixels"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setSkipPixels</span>(<span class="type">int</span> <i>skipPixels</i>)</h3> <p>Sets the number of pixels that are skipped to <i>skipPixels</i>. Corresponds to <code>GL_UNPACK_SKIP_PIXELS</code>. Equivalent to incrementing the pointer passed to <a href="qopengltexture.html#setData">QOpenGLTexture::setData</a>(). The default value is 0.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#skipPixels">skipPixels</a>().</p> <!-- @@@setSkipPixels --> <!-- $$$setSkipRows[overload1]$$$setSkipRowsint --> <h3 class="fn" id="setSkipRows"><a name="setSkipRows"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setSkipRows</span>(<span class="type">int</span> <i>skipRows</i>)</h3> <p>Sets the number of rows that are skipped to <i>skipRows</i>. Corresponds to <code>GL_UNPACK_SKIP_ROWS</code>. Equivalent to incrementing the pointer passed to <a href="qopengltexture.html#setData">QOpenGLTexture::setData</a>(). The default value is 0.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#skipRows">skipRows</a>().</p> <!-- @@@setSkipRows --> <!-- $$$setSwapBytesEnabled[overload1]$$$setSwapBytesEnabledbool --> <h3 class="fn" id="setSwapBytesEnabled"><a name="setSwapBytesEnabled"></a><span class="type">void</span> QOpenGLPixelTransferOptions::<span class="name">setSwapBytesEnabled</span>(<span class="type">bool</span> <i>swapBytes</i>)</h3> <p><i>swapBytes</i> specifies if the byte ordering for multibyte components is reversed. The default value is <code>false</code>. Corresponds to <code>GL_UNPACK_SWAP_BYTES</code>.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#isSwapBytesEnabled">isSwapBytesEnabled</a>().</p> <!-- @@@setSwapBytesEnabled --> <!-- $$$skipImages[overload1]$$$skipImages --> <h3 class="fn" id="skipImages"><a name="skipImages"></a><span class="type">int</span> QOpenGLPixelTransferOptions::<span class="name">skipImages</span>() const</h3> <p>Returns the number of images that are skipped.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#setSkipImages">setSkipImages</a>().</p> <!-- @@@skipImages --> <!-- $$$skipPixels[overload1]$$$skipPixels --> <h3 class="fn" id="skipPixels"><a name="skipPixels"></a><span class="type">int</span> QOpenGLPixelTransferOptions::<span class="name">skipPixels</span>() const</h3> <p>Returns the number of pixels that are skipped.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#setSkipPixels">setSkipPixels</a>().</p> <!-- @@@skipPixels --> <!-- $$$skipRows[overload1]$$$skipRows --> <h3 class="fn" id="skipRows"><a name="skipRows"></a><span class="type">int</span> QOpenGLPixelTransferOptions::<span class="name">skipRows</span>() const</h3> <p>Returns the number of rows that are skipped.</p> <p><b>See also </b><a href="qopenglpixeltransferoptions.html#setSkipRows">setSkipRows</a>().</p> <!-- @@@skipRows --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>