diff options
Diffstat (limited to 'doc/html/qglformat.html')
| -rw-r--r-- | doc/html/qglformat.html | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/doc/html/qglformat.html b/doc/html/qglformat.html index 587172f2a..68cdd8bdc 100644 --- a/doc/html/qglformat.html +++ b/doc/html/qglformat.html @@ -107,8 +107,8 @@ a rendering context. One is to create a TQGLFormat and make it the default for the entire application: <pre> TQGLFormat f; - f.<a href="#setAlpha">setAlpha</a>( TRUE ); - f.<a href="#setStereo">setStereo</a>( TRUE ); + f.<a href="#setAlpha">setAlpha</a>( true ); + f.<a href="#setStereo">setStereo</a>( true ); TQGLFormat::<a href="#setDefaultFormat">setDefaultFormat</a>( f ); </pre> @@ -116,8 +116,8 @@ default for the entire application: your TQGLWidget subclass: <pre> TQGLFormat f; - f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( FALSE ); // single buffer - f.<a href="#setDirectRendering">setDirectRendering</a>( FALSE ); // software rendering + f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( false ); // single buffer + f.<a href="#setDirectRendering">setDirectRendering</a>( false ); // software rendering MyGLWidget* myWidget = new MyGLWidget( f, ... ); </pre> @@ -125,8 +125,8 @@ your TQGLWidget subclass: requested features the system was able to provide: <pre> TQGLFormat f; - f.<a href="#setOverlay">setOverlay</a>( TRUE ); - f.<a href="#setStereo">setStereo</a>( TRUE ); + f.<a href="#setOverlay">setOverlay</a>( true ); + f.<a href="#setStereo">setStereo</a>( true ); MyGLWidget* myWidget = new MyGLWidget( f, ... ); if ( !w->format().stereo() ) { // ok, goggles off @@ -190,15 +190,15 @@ supports overlay/underlay rendering planes. <h3 class=fn>bool <a name="accum"></a>TQGLFormat::accum () const </h3> -<p> Returns TRUE if the accumulation buffer is enabled; otherwise -returns FALSE. The accumulation buffer is disabled by default. +<p> Returns true if the accumulation buffer is enabled; otherwise +returns false. The accumulation buffer is disabled by default. <p> <p>See also <a href="#setAccum">setAccum</a>(). <h3 class=fn>bool <a name="alpha"></a>TQGLFormat::alpha () const </h3> -<p> Returns TRUE if the alpha channel of the framebuffer is enabled; -otherwise returns FALSE. The alpha channel is disabled by default. +<p> Returns true if the alpha channel of the framebuffer is enabled; +otherwise returns false. The alpha channel is disabled by default. <p> <p>See also <a href="#setAlpha">setAlpha</a>(). <h3 class=fn><a href="qglformat.html">TQGLFormat</a> <a name="defaultFormat"></a>TQGLFormat::defaultFormat ()<tt> [static]</tt> @@ -232,45 +232,45 @@ Returns the default TQGLFormat for overlay contexts. <h3 class=fn>bool <a name="depth"></a>TQGLFormat::depth () const </h3> -<p> Returns TRUE if the depth buffer is enabled; otherwise returns -FALSE. The depth buffer is enabled by default. +<p> Returns true if the depth buffer is enabled; otherwise returns +false. The depth buffer is enabled by default. <p> <p>See also <a href="#setDepth">setDepth</a>(). <h3 class=fn>bool <a name="directRendering"></a>TQGLFormat::directRendering () const </h3> -<p> Returns TRUE if direct rendering is enabled; otherwise returns -FALSE. +<p> Returns true if direct rendering is enabled; otherwise returns +false. <p> Direct rendering is enabled by default. <p> <p>See also <a href="#setDirectRendering">setDirectRendering</a>(). <h3 class=fn>bool <a name="doubleBuffer"></a>TQGLFormat::doubleBuffer () const </h3> -<p> Returns TRUE if double buffering is enabled; otherwise returns -FALSE. Double buffering is enabled by default. +<p> Returns true if double buffering is enabled; otherwise returns +false. Double buffering is enabled by default. <p> <p>See also <a href="#setDoubleBuffer">setDoubleBuffer</a>(). <h3 class=fn>bool <a name="hasOpenGL"></a>TQGLFormat::hasOpenGL ()<tt> [static]</tt> </h3> -<p> Returns TRUE if the window system has any OpenGL support; -otherwise returns FALSE. +<p> Returns true if the window system has any OpenGL support; +otherwise returns false. <p> <b>Warning:</b> This function must not be called until the <a href="ntqapplication.html">TQApplication</a> object has been created. <h3 class=fn>bool <a name="hasOpenGLOverlays"></a>TQGLFormat::hasOpenGLOverlays ()<tt> [static]</tt> </h3> -<p> Returns TRUE if the window system supports OpenGL overlays; -otherwise returns FALSE. +<p> Returns true if the window system supports OpenGL overlays; +otherwise returns false. <p> <b>Warning:</b> This function must not be called until the <a href="ntqapplication.html">TQApplication</a> object has been created. <h3 class=fn>bool <a name="hasOverlay"></a>TQGLFormat::hasOverlay () const </h3> -<p> Returns TRUE if overlay plane is enabled; otherwise returns FALSE. +<p> Returns true if overlay plane is enabled; otherwise returns false. <p> Overlay is disabled by default. <p> <p>See also <a href="#setOverlay">setOverlay</a>(). @@ -284,13 +284,13 @@ formats is 1, which is the first overlay plane. <h3 class=fn>bool <a name="rgba"></a>TQGLFormat::rgba () const </h3> -<p> Returns TRUE if RGBA color mode is set. Returns FALSE if color +<p> Returns true if RGBA color mode is set. Returns false if color index mode is set. The default color mode is RGBA. <p> <p>See also <a href="#setRgba">setRgba</a>(). <h3 class=fn>void <a name="setAccum"></a>TQGLFormat::setAccum ( bool enable ) </h3> -If <em>enable</em> is TRUE enables the accumulation buffer; otherwise +If <em>enable</em> is true enables the accumulation buffer; otherwise disables the accumulation buffer. <p> The accumulation buffer is disabled by default. <p> The accumulation buffer is used to create blur effects and @@ -299,7 +299,7 @@ multiple exposures. <h3 class=fn>void <a name="setAlpha"></a>TQGLFormat::setAlpha ( bool enable ) </h3> -If <em>enable</em> is TRUE enables the alpha channel; otherwise disables +If <em>enable</em> is true enables the alpha channel; otherwise disables the alpha channel. <p> The alpha buffer is disabled by default. <p> The alpha channel is typically used for implementing transparency @@ -315,7 +315,7 @@ buffering, your main() might contain code like this: <pre> <a href="ntqapplication.html">TQApplication</a> a(argc, argv); TQGLFormat f; - f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( FALSE ); + f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( false ); TQGLFormat::<a href="#setDefaultFormat">setDefaultFormat</a>( f ); </pre> @@ -330,7 +330,7 @@ format is used whenever a <a href="qglwidget.html">TQGLWidget</a> is created wit available), use code like this: <p> <pre> TQGLFormat f = TQGLFormat::<a href="#defaultOverlayFormat">defaultOverlayFormat</a>(); - f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( TRUE ); + f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( true ); TQGLFormat::<a href="#setDefaultOverlayFormat">setDefaultOverlayFormat</a>( f ); </pre> @@ -354,7 +354,7 @@ specification: <h3 class=fn>void <a name="setDepth"></a>TQGLFormat::setDepth ( bool enable ) </h3> -If <em>enable</em> is TRUE enables the depth buffer; otherwise disables +If <em>enable</em> is true enables the depth buffer; otherwise disables the depth buffer. <p> The depth buffer is enabled by default. <p> The purpose of a depth buffer (or Z-buffering) is to remove hidden @@ -366,7 +366,7 @@ decide whether to draw a pixel or not. <h3 class=fn>void <a name="setDirectRendering"></a>TQGLFormat::setDirectRendering ( bool enable ) </h3> -If <em>enable</em> is TRUE enables direct rendering; otherwise disables +If <em>enable</em> is true enables direct rendering; otherwise disables direct rendering. <p> Direct rendering is enabled by default. <p> Enabling this option will make OpenGL bypass the underlying window @@ -376,7 +376,7 @@ supported by the system. <h3 class=fn>void <a name="setDoubleBuffer"></a>TQGLFormat::setDoubleBuffer ( bool enable ) </h3> -If <em>enable</em> is TRUE sets double buffering; otherwise sets single +If <em>enable</em> is true sets double buffering; otherwise sets single buffering. <p> Double buffering is enabled by default. <p> Double buffering is a technique where graphics are rendered on an @@ -393,7 +393,7 @@ Sets the format option to <em>opt</em>. <h3 class=fn>void <a name="setOverlay"></a>TQGLFormat::setOverlay ( bool enable ) </h3> -If <em>enable</em> is TRUE enables an overlay plane; otherwise disables +If <em>enable</em> is true enables an overlay plane; otherwise disables the overlay plane. <p> Enabling the overlay plane will cause <a href="qglwidget.html">TQGLWidget</a> to create an additional context in an overlay plane. See the TQGLWidget @@ -414,7 +414,7 @@ created. <h3 class=fn>void <a name="setRgba"></a>TQGLFormat::setRgba ( bool enable ) </h3> -If <em>enable</em> is TRUE sets RGBA mode. If <em>enable</em> is FALSE sets +If <em>enable</em> is true sets RGBA mode. If <em>enable</em> is false sets color index mode. <p> The default color mode is RGBA. <p> RGBA is the preferred mode for most OpenGL applications. In RGBA @@ -426,7 +426,7 @@ table. <h3 class=fn>void <a name="setStencil"></a>TQGLFormat::setStencil ( bool enable ) </h3> -If <em>enable</em> is TRUE enables the stencil buffer; otherwise +If <em>enable</em> is true enables the stencil buffer; otherwise disables the stencil buffer. <p> The stencil buffer is disabled by default. <p> The stencil buffer masks certain parts of the drawing area so that @@ -435,7 +435,7 @@ masked parts are not drawn on. <h3 class=fn>void <a name="setStereo"></a>TQGLFormat::setStereo ( bool enable ) </h3> -If <em>enable</em> is TRUE enables stereo buffering; otherwise disables +If <em>enable</em> is true enables stereo buffering; otherwise disables stereo buffering. <p> Stereo buffering is disabled by default. <p> Stereo buffering provides extra color buffers to generate left-eye @@ -445,20 +445,20 @@ and right-eye images. <h3 class=fn>bool <a name="stencil"></a>TQGLFormat::stencil () const </h3> -<p> Returns TRUE if the stencil buffer is enabled; otherwise returns -FALSE. The stencil buffer is disabled by default. +<p> Returns true if the stencil buffer is enabled; otherwise returns +false. The stencil buffer is disabled by default. <p> <p>See also <a href="#setStencil">setStencil</a>(). <h3 class=fn>bool <a name="stereo"></a>TQGLFormat::stereo () const </h3> -<p> Returns TRUE if stereo buffering is enabled; otherwise returns -FALSE. Stereo buffering is disabled by default. +<p> Returns true if stereo buffering is enabled; otherwise returns +false. Stereo buffering is disabled by default. <p> <p>See also <a href="#setStereo">setStereo</a>(). <h3 class=fn>bool <a name="testOption"></a>TQGLFormat::testOption ( <a href="ntqgl.html#FormatOption-enum">FormatOption</a> opt ) const </h3> -Returns TRUE if format option <em>opt</em> is set; otherwise returns FALSE. +Returns true if format option <em>opt</em> is set; otherwise returns false. <p> <p>See also <a href="#setOption">setOption</a>(). <!-- eof --> |