Update of /cvsroot/artoolkit/artoolkit/doc/gsub_lite
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24806
Modified Files:
toc.html CompositePage.html
Log Message:
Update for gsub_lite rev 2.8.1.
Index: toc.html
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/toc.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** toc.html 5 Apr 2006 05:47:02 -0000 1.5
--- toc.html 27 Apr 2006 18:52:55 -0000 1.6
***************
*** 24,39 ****
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglDistortionCompensationGet" target="doc">arglDistortionCompensationGet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglDistortionCompensationSet" target="doc">arglDistortionCompensationSet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglPixelFormatGet" target="doc">arglPixelFormatGet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglPixelFormatSet" target="doc">arglPixelFormatSet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglSetupForCurrentContext" target="doc">arglSetupForCurrentContext</a></nobr><br>
<h4><a href="DataTypes/DataTypes.html" target="doc">Defined Types
</a></h4>
<nobr> <a href="DataTypes/DataTypes.html#//apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF" target="doc">ARGL_CONTEXT_SETTINGS_REF</a></nobr><br>
- <h4><a href="Vars/Vars.html" target="doc">Globals</a></h4>
-
- <nobr> <a href="Vars/Vars.html#//apple_ref/c/data/arglDrawMode" target="doc">arglDrawMode</a></nobr><br>
- <nobr> <a href="Vars/Vars.html#//apple_ref/c/data/arglTexmapMode" target="doc">arglTexmapMode</a></nobr><br>
- <nobr> <a href="Vars/Vars.html#//apple_ref/c/data/arglTexRectangle" target="doc">arglTexRectangle</a></nobr><br>
<br><hr><a href="CompositePage.html" target="_blank">[Printable HTML Page]</a>
<p><i>Updated: August 29, 2005</i><p></td></tr>
--- 24,37 ----
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglDistortionCompensationGet" target="doc">arglDistortionCompensationGet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglDistortionCompensationSet" target="doc">arglDistortionCompensationSet</a></nobr><br>
+ <nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglDrawModeSet" target="doc">arglDrawModeSet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglPixelFormatGet" target="doc">arglPixelFormatGet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglPixelFormatSet" target="doc">arglPixelFormatSet</a></nobr><br>
<nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglSetupForCurrentContext" target="doc">arglSetupForCurrentContext</a></nobr><br>
+ <nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglTexmapModeSet" target="doc">arglTexmapModeSet</a></nobr><br>
+ <nobr> <a href="Functions/Functions.html#//apple_ref/c/func/arglTexRectangleSet" target="doc">arglTexRectangleSet</a></nobr><br>
<h4><a href="DataTypes/DataTypes.html" target="doc">Defined Types
</a></h4>
<nobr> <a href="DataTypes/DataTypes.html#//apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF" target="doc">ARGL_CONTEXT_SETTINGS_REF</a></nobr><br>
<br><hr><a href="CompositePage.html" target="_blank">[Printable HTML Page]</a>
<p><i>Updated: August 29, 2005</i><p></td></tr>
Index: CompositePage.html
===================================================================
RCS file: /cvsroot/artoolkit/artoolkit/doc/gsub_lite/CompositePage.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** CompositePage.html 22 Sep 2005 00:08:15 -0000 1.5
--- CompositePage.html 27 Apr 2006 18:52:55 -0000 1.6
***************
*** 91,94 ****
--- 91,97 ----
<dd>Set compensation for camera lens distortion in arglDispImage to off or on.
</dd>
+ <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/c/func/arglDrawModeSet" target="_top">arglDrawModeSet</a></tt></dt>
+ <dd>Set method by which arglDispImage() transfers pixels.
+ </dd>
<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/c/func/arglPixelFormatGet" target="_top">arglPixelFormatGet</a></tt></dt>
<dd>Get the format of pixel data in which arglDispImage*() is expecting data to be passed.
***************
*** 100,103 ****
--- 103,112 ----
<dd>Initialise the gsub_lite library for the current OpenGL context.
</dd>
+ <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/c/func/arglTexmapModeSet" target="_top">arglTexmapModeSet</a></tt></dt>
+ <dd>Determines use of full or half-resolution TexImage2D pixel-transfer in arglDispImage().
+ </dd>
+ <dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/c/func/arglTexRectangleSet" target="_top">arglTexRectangleSet</a></tt></dt>
+ <dd>Determines use of rectangular TexImage2D pixel-transfer in arglDispImage().
+ </dd>
</dl>
<hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglCameraFrustum; name=arglCameraFrustum -->
***************
*** 163,167 ****
is specified in column major order.</dd>
<dt><code><i>scale</i></code></dt><dd>Specifies a scaling between ARToolKit's
! units (usually millimeters) and OpenGL's coordinate system units.</dd>
</dl>
</blockquote>
--- 172,179 ----
is specified in column major order.</dd>
<dt><code><i>scale</i></code></dt><dd>Specifies a scaling between ARToolKit's
! units (usually millimeters) and OpenGL's coordinate system units.
! What you pass for the scalefactor parameter depends on what units you
! want to do your OpenGL drawing in. If you use a scalefactor of 1.0, then<br>
! To use different OpenGL units, e.g. metres, then you would pass 0.001.</li></ol></dd>
</dl>
</blockquote>
***************
*** 344,347 ****
--- 356,384 ----
</dd>
</dl>
+ <hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglDrawModeSet; name=arglDrawModeSet -->
+ <a name="//apple_ref/doc/compositePage/c/func/arglDrawModeSet"></a>
+ <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglDrawModeSet">arglDrawModeSet</a></h3>
+ </td></tr></table><hr><dl></dl><p>Set method by which arglDispImage() transfers pixels.
+ </p>
+ <blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/void //apple_ref/c/cl/void //apple_ref/c/tdef/void //apple_ref/c/tag/void //apple_ref/c/econst/void //apple_ref/c/struct/void //apple_ref/c/clconst/void" --><font class="type">void</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglDrawModeSet //apple_ref/c/clm/arglDrawModeSet //apple_ref/c/intfcm/arglDrawModeSet //apple_ref/c/func/arglDrawModeSet //apple_ref/c/ftmplt/arglDrawModeSet //apple_ref/c/defn/arglDrawModeSet //apple_ref/c/macro/arglDrawModeSet" --><font class="function">arglDrawModeSet</font><!-- /a -->(
+ <!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
+ <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <font class="param">mode</font>); </pre></blockquote>
+ <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>The value of this setting determines the method by which
+ arglDispImage transfers pixels of an image to the display. Setting this
+ variable to a value of AR_DRAW_BY_GL_DRAW_PIXELS specifies the use of OpenGL
+ DrawPixels to do the transfer. Setting this variable to a value of
+ AR_DRAW_BY_TEXTURE_MAPPING specifies the use of OpenGL TexImage2D to do the
+ transfer. The DrawPixels method is guaranteed to be available on all
+ implementations, but arglDispImage does not correct the image
+ for camera lens distortion under this method. In contrast, TexImage2D is only
+ available on some implementations, but allows arglDispImage() to apply a correction
+ for camera lens distortion, and additionally offers greater potential for
+ accelerated drawing on some implementations.
+ <br><br>
+ The initial value is AR_DRAW_BY_TEXTURE_MAPPING.
+ </p>
+ <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
+ </dd>
+ </dl>
<hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglPixelFormatGet; name=arglPixelFormatGet -->
<a name="//apple_ref/doc/compositePage/c/func/arglPixelFormatGet"></a>
***************
*** 351,355 ****
<blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglPixelFormatGet //apple_ref/c/clm/arglPixelFormatGet //apple_ref/c/intfcm/arglPixelFormatGet //apple_ref/c/func/arglPixelFormatGet //apple_ref/c/ftmplt/arglPixelFormatGet //apple_ref/c/defn/arglPixelFormatGet //apple_ref/c/macro/arglPixelFormatGet" --><font class="function">arglPixelFormatGet</font><!-- /a -->(
<!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/tdef/ARGL_PIX_FORMAT //apple_ref/c/tag/ARGL_PIX_FORMAT //apple_ref/c/econst/ARGL_PIX_FORMAT //apple_ref/c/struct/ARGL_PIX_FORMAT //apple_ref/c/clconst/ARGL_PIX_FORMAT" --><font class="type">ARGL_PIX_FORMAT</font><!-- /a --> *<font class="param">format</font>,
<!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> *<font class="param">size</font>); </pre></blockquote>
<h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5>
--- 388,392 ----
<blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglPixelFormatGet //apple_ref/c/clm/arglPixelFormatGet //apple_ref/c/intfcm/arglPixelFormatGet //apple_ref/c/func/arglPixelFormatGet //apple_ref/c/ftmplt/arglPixelFormatGet //apple_ref/c/defn/arglPixelFormatGet //apple_ref/c/macro/arglPixelFormatGet" --><font class="function">arglPixelFormatGet</font><!-- /a -->(
<!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
! <!-- a logicalPath="//apple_ref/c/cl/AR_PIXEL_FORMAT //apple_ref/c/cl/AR_PIXEL_FORMAT //apple_ref/c/tdef/AR_PIXEL_FORMAT //apple_ref/c/tag/AR_PIXEL_FORMAT //apple_ref/c/econst/AR_PIXEL_FORMAT //apple_ref/c/struct/AR_PIXEL_FORMAT //apple_ref/c/clconst/AR_PIXEL_FORMAT" --><font class="type">AR_PIXEL_FORMAT</font><!-- /a --> *<font class="param">format</font>,
<!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> *<font class="param">size</font>); </pre></blockquote>
<h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5>
***************
*** 359,363 ****
context, as returned by arglSetupForCurrentContext() for this context.</dd>
<dt><code><i>format</i></code></dt><dd>A symbolic constant for the pixel format in use. See
! <!-- a logicalPath="//apple_ref/c/tdef/ARGL_PIX_FORMAT" -->ARGL_PIX_FORMAT <!-- /a --> for a list of all possible formats.</dd>
<dt><code><i>size</i></code></dt><dd>The number of bytes of memory occupied per pixel, for the given format.</dd>
</dl>
--- 396,400 ----
context, as returned by arglSetupForCurrentContext() for this context.</dd>
<dt><code><i>format</i></code></dt><dd>A symbolic constant for the pixel format in use. See
! <!-- a logicalPath="" -->AR_PIXEL_FORMAT <!-- /a --> for a list of all possible formats.</dd>
<dt><code><i>size</i></code></dt><dd>The number of bytes of memory occupied per pixel, for the given format.</dd>
</dl>
***************
*** 367,372 ****
<h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>This function enquires as to the current format of pixel data being
expected by the arglDispImage*() functions. The default format is determined by
! which of the possible AR_PIXEL_FORMAT_xxxx symbols was defined at the time the
! library was built.
</p>
<dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.71.
--- 404,408 ----
<h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>This function enquires as to the current format of pixel data being
expected by the arglDispImage*() functions. The default format is determined by
! the value of AR_DEFAULT_PIXEL_FORMAT at the time the library was built.
</p>
<dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.71.
***************
*** 380,384 ****
<blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglPixelFormatSet //apple_ref/c/clm/arglPixelFormatSet //apple_ref/c/intfcm/arglPixelFormatSet //apple_ref/c/func/arglPixelFormatSet //apple_ref/c/ftmplt/arglPixelFormatSet //apple_ref/c/defn/arglPixelFormatSet //apple_ref/c/macro/arglPixelFormatSet" --><font class="function">arglPixelFormatSet</font><!-- /a -->(
<!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/cl/ARGL_PIX_FORMAT //apple_ref/c/tdef/ARGL_PIX_FORMAT //apple_ref/c/tag/ARGL_PIX_FORMAT //apple_ref/c/econst/ARGL_PIX_FORMAT //apple_ref/c/struct/ARGL_PIX_FORMAT //apple_ref/c/clconst/ARGL_PIX_FORMAT" --><font class="type">ARGL_PIX_FORMAT</font><!-- /a --> <font class="param">format</font>); </pre></blockquote>
<h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5>
<blockquote>
--- 416,420 ----
<blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglPixelFormatSet //apple_ref/c/clm/arglPixelFormatSet //apple_ref/c/intfcm/arglPixelFormatSet //apple_ref/c/func/arglPixelFormatSet //apple_ref/c/ftmplt/arglPixelFormatSet //apple_ref/c/defn/arglPixelFormatSet //apple_ref/c/macro/arglPixelFormatSet" --><font class="function">arglPixelFormatSet</font><!-- /a -->(
<!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
! <!-- a logicalPath="//apple_ref/c/cl/AR_PIXEL_FORMAT //apple_ref/c/cl/AR_PIXEL_FORMAT //apple_ref/c/tdef/AR_PIXEL_FORMAT //apple_ref/c/tag/AR_PIXEL_FORMAT //apple_ref/c/econst/AR_PIXEL_FORMAT //apple_ref/c/struct/AR_PIXEL_FORMAT //apple_ref/c/clconst/AR_PIXEL_FORMAT" --><font class="type">AR_PIXEL_FORMAT</font><!-- /a --> <font class="param">format</font>); </pre></blockquote>
<h5><font face="Lucida Grande,Helvetica,Arial">Parameter Descriptions</font></h5>
<blockquote>
***************
*** 387,391 ****
context, as returned by arglSetupForCurrentContext() for this context.</dd>
<dt><code><i>format</i></code></dt><dd>A symbolic constant for the pixel format being set. See
! <!-- a logicalPath="//apple_ref/c/tdef/ARGL_PIX_FORMAT" -->ARGL_PIX_FORMAT <!-- /a --> for a list of all possible formats.</dd>
</dl>
</blockquote>
--- 423,427 ----
context, as returned by arglSetupForCurrentContext() for this context.</dd>
<dt><code><i>format</i></code></dt><dd>A symbolic constant for the pixel format being set. See
! <!-- a logicalPath="" -->AR_PIXEL_FORMAT <!-- /a --> for a list of all possible formats.</dd>
</dl>
</blockquote>
***************
*** 397,402 ****
gsub_lite the format the pixels being passed to arglDispImage*() functions
are in. This setting applies only to the context passed in parameter
! contextSettings. The default format is determined by which of the possible
! AR_PIXEL_FORMAT_xxxx symbols was defined at the time the library was built.
Usually, image data is passed in directly from images generated by ARVideo,
and so you should ensure that ARVideo is generating pixels of the same format.
--- 433,438 ----
gsub_lite the format the pixels being passed to arglDispImage*() functions
are in. This setting applies only to the context passed in parameter
! contextSettings. The default format is determined by
! the value of AR_DEFAULT_PIXEL_FORMAT at the time the library was built.
Usually, image data is passed in directly from images generated by ARVideo,
and so you should ensure that ARVideo is generating pixels of the same format.
***************
*** 432,554 ****
</dd>
</dl>
! <h2>Typedefs</h2>
! <hr><!-- headerDoc=tdef; uid=//apple_ref/doc/compositePage/c/tdef/ARGL_CONTEXT_SETTINGS_REF; name=ARGL_CONTEXT_SETTINGS_REF -->
! <a name="//apple_ref/doc/compositePage/c/tdef/ARGL_CONTEXT_SETTINGS_REF"></a>
! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="ARGL_CONTEXT_SETTINGS_REF">ARGL_CONTEXT_SETTINGS_REF</a></h3>
! </td></tr></table><hr><dl></dl><p>Opaque type to hold ARGL settings for a given OpenGL context.
! </p>
! <blockquote><pre><font class="keyword">typedef</font> <font class="keyword">struct</font> <!-- a logicalPath="//apple_ref/c/cl/_ARGL_CONTEXT_SETTINGS //apple_ref/c/cl/_ARGL_CONTEXT_SETTINGS //apple_ref/c/tdef/_ARGL_CONTEXT_SETTINGS //apple_ref/c/tag/_ARGL_CONTEXT_SETTINGS //apple_ref/c/econst/_ARGL_CONTEXT_SETTINGS //apple_ref/c/struct/_ARGL_CONTEXT_SETTINGS //apple_ref/c/clconst/_ARGL_CONTEXT_SETTINGS" --><font class="type">_ARGL_CONTEXT_SETTINGS</font><!-- /a --> <font class="type">*</font><font class="var">ARGL_CONTEXT_SETTINGS_REF</font>; </pre></blockquote>
! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>An OpenGL context is an implementation-defined structure which
! keeps track of OpenGL state, including textures and display lists.
! Typically, individual OpenGL windows will have distinct OpenGL
! contexts assigned to them by the host operating system.
! <br><br>
! As gsub_lite uses textures and display lists, it must be able to
! track which OpenGL context a given texture or display list it is using
! belongs to. This is especially important when gsub_lite is being used to
! draw into more than one window (and therefore more than one context.)
! <br><br>
! Basically, functions which depend on OpenGL state, will require an
! ARGL_CONTEXT_SETTINGS_REF to be passed to them. An ARGL_CONTEXT_SETTINGS_REF
! is generated by setting the current OpenGL context (e.g. if using GLUT,
! you might call glutSetWindow()) and then calling arglSetupForCurrentContext().
! When you have finished using ARGL in a given context, you should call
! arglCleanup(), passing in an ARGL_CONTEXT_SETTINGS_REF, to free the
! memory used by the settings structure.
! </p>
! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
! </dd>
! </dl>
! <hr><!-- headerDoc=tdef; uid=//apple_ref/doc/compositePage/c/tdef/ARGL_PIX_FORMAT; name=ARGL_PIX_FORMAT -->
! <a name="//apple_ref/doc/compositePage/c/tdef/ARGL_PIX_FORMAT"></a>
! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="ARGL_PIX_FORMAT">ARGL_PIX_FORMAT</a></h3>
! </td></tr></table><hr><dl></dl><p>ARToolKit pixel-format specifiers.
! </p>
! <blockquote><pre><font class="keyword">typedef</font> <font class="keyword">enum</font> {
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_RGBA //apple_ref/c/cl/ARGL_PIX_FORMAT_RGBA //apple_ref/c/tdef/ARGL_PIX_FORMAT_RGBA //apple_ref/c/tag/ARGL_PIX_FORMAT_RGBA //apple_ref/c/econst/ARGL_PIX_FORMAT_RGBA //apple_ref/c/struct/ARGL_PIX_FORMAT_RGBA //apple_ref/c/clconst/ARGL_PIX_FORMAT_RGBA" --><font class="type">ARGL_PIX_FORMAT_RGBA</font><!-- /a --> = <font class="number">1</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_ABGR //apple_ref/c/cl/ARGL_PIX_FORMAT_ABGR //apple_ref/c/tdef/ARGL_PIX_FORMAT_ABGR //apple_ref/c/tag/ARGL_PIX_FORMAT_ABGR //apple_ref/c/econst/ARGL_PIX_FORMAT_ABGR //apple_ref/c/struct/ARGL_PIX_FORMAT_ABGR //apple_ref/c/clconst/ARGL_PIX_FORMAT_ABGR" --><font class="type">ARGL_PIX_FORMAT_ABGR</font><!-- /a --> = <font class="number">2</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_BGRA //apple_ref/c/cl/ARGL_PIX_FORMAT_BGRA //apple_ref/c/tdef/ARGL_PIX_FORMAT_BGRA //apple_ref/c/tag/ARGL_PIX_FORMAT_BGRA //apple_ref/c/econst/ARGL_PIX_FORMAT_BGRA //apple_ref/c/struct/ARGL_PIX_FORMAT_BGRA //apple_ref/c/clconst/ARGL_PIX_FORMAT_BGRA" --><font class="type">ARGL_PIX_FORMAT_BGRA</font><!-- /a --> = <font class="number">3</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_ARGB //apple_ref/c/cl/ARGL_PIX_FORMAT_ARGB //apple_ref/c/tdef/ARGL_PIX_FORMAT_ARGB //apple_ref/c/tag/ARGL_PIX_FORMAT_ARGB //apple_ref/c/econst/ARGL_PIX_FORMAT_ARGB //apple_ref/c/struct/ARGL_PIX_FORMAT_ARGB //apple_ref/c/clconst/ARGL_PIX_FORMAT_ARGB" --><font class="type">ARGL_PIX_FORMAT_ARGB</font><!-- /a --> = <font class="number">4</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_RGB //apple_ref/c/cl/ARGL_PIX_FORMAT_RGB //apple_ref/c/tdef/ARGL_PIX_FORMAT_RGB //apple_ref/c/tag/ARGL_PIX_FORMAT_RGB //apple_ref/c/econst/ARGL_PIX_FORMAT_RGB //apple_ref/c/struct/ARGL_PIX_FORMAT_RGB //apple_ref/c/clconst/ARGL_PIX_FORMAT_RGB" --><font class="type">ARGL_PIX_FORMAT_RGB</font><!-- /a --> = <font class="number">5</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_BGR //apple_ref/c/cl/ARGL_PIX_FORMAT_BGR //apple_ref/c/tdef/ARGL_PIX_FORMAT_BGR //apple_ref/c/tag/ARGL_PIX_FORMAT_BGR //apple_ref/c/econst/ARGL_PIX_FORMAT_BGR //apple_ref/c/struct/ARGL_PIX_FORMAT_BGR //apple_ref/c/clconst/ARGL_PIX_FORMAT_BGR" --><font class="type">ARGL_PIX_FORMAT_BGR</font><!-- /a --> = <font class="number">6</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_2vuy //apple_ref/c/cl/ARGL_PIX_FORMAT_2vuy //apple_ref/c/tdef/ARGL_PIX_FORMAT_2vuy //apple_ref/c/tag/ARGL_PIX_FORMAT_2vuy //apple_ref/c/econst/ARGL_PIX_FORMAT_2vuy //apple_ref/c/struct/ARGL_PIX_FORMAT_2vuy //apple_ref/c/clconst/ARGL_PIX_FORMAT_2vuy" --><font class="type">ARGL_PIX_FORMAT_2vuy</font><!-- /a --> = <font class="number">7</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_UYVY //apple_ref/c/cl/ARGL_PIX_FORMAT_UYVY //apple_ref/c/tdef/ARGL_PIX_FORMAT_UYVY //apple_ref/c/tag/ARGL_PIX_FORMAT_UYVY //apple_ref/c/econst/ARGL_PIX_FORMAT_UYVY //apple_ref/c/struct/ARGL_PIX_FORMAT_UYVY //apple_ref/c/clconst/ARGL_PIX_FORMAT_UYVY" --><font class="type">ARGL_PIX_FORMAT_UYVY</font><!-- /a --> = <font class="var">ARGL_PIX_FORMAT_2vuy</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_yuvs //apple_ref/c/cl/ARGL_PIX_FORMAT_yuvs //apple_ref/c/tdef/ARGL_PIX_FORMAT_yuvs //apple_ref/c/tag/ARGL_PIX_FORMAT_yuvs //apple_ref/c/econst/ARGL_PIX_FORMAT_yuvs //apple_ref/c/struct/ARGL_PIX_FORMAT_yuvs //apple_ref/c/clconst/ARGL_PIX_FORMAT_yuvs" --><font class="type">ARGL_PIX_FORMAT_yuvs</font><!-- /a --> = <font class="number">8</font>,
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/cl/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/tdef/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/tag/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/econst/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/struct/ARGL_PIX_FORMAT_YUY2 //apple_ref/c/clconst/ARGL_PIX_FORMAT_YUY2" --><font class="type">ARGL_PIX_FORMAT_YUY2</font><!-- /a --> = <font class="var">ARGL_PIX_FORMAT_yuvs</font>,
! } <font class="var">ARGL_PIX_FORMAT</font>; </pre></blockquote>
! <h5><font face="Lucida Grande,Helvetica,Arial">Constants</font></h5>
! <blockquote>
! <dl>
! <dt><code>ARGL_PIX_FORMAT_RGBA</code></dt><dd>Each pixel is represented by 32 bits. Eight bits per each Red, Green,
! Blue, and Alpha component.</dd>
! <dt><code>ARGL_PIX_FORMAT_ABGR</code></dt><dd>Each pixel is represented by 32 bits. Eight bits per each Alpha, Blue,
! Green, and Red component. This is the native 32 bit format for the SGI
! platform.</dd>
! <dt><code>ARGL_PIX_FORMAT_BGRA</code></dt><dd>Each pixel is represented by 32 bits. Eight bits per each Blue, Green,
! Red, and Alpha component. This is the native 32 bit format for the Win32
! platform.</dd>
! <dt><code>ARGL_PIX_FORMAT_ARGB</code></dt><dd>Each pixel is represented by 32 bits. Eight bits per each Alpha, Red,
! Green, and Blue component. This is the native 32 bit format for the Mac
! platform.</dd>
! <dt><code>ARGL_PIX_FORMAT_RGB</code></dt><dd>Each pixel is represented by 24 bits. Eight bits per each Red, Green,
! and Blue component. This is the native 24 bit format for the Mac platform.</dd>
! <dt><code>ARGL_PIX_FORMAT_BGR</code></dt><dd>Each pixel is represented by 24 bits. Eight bits per each Blue, Red, and
! Green component. This is the native 24 bit format for the Win32 platform.</dd>
! <dt><code>ARGL_PIX_FORMAT_2vuy</code></dt><dd>8-bit 4:2:2 Component Y'CbCr format. Each 16 bit pixel is represented
! by an unsigned eight bit luminance component and two unsigned eight bit
! chroma components. Each pair of pixels shares a common set of chroma
! values. The components are ordered in memory; Cb, Y0, Cr, Y1. The
! luminance components have a range of [16, 235], while the chroma value
! has a range of [16, 240]. This is consistent with the CCIR601 spec.
! This format is fairly prevalent on both Mac and Win32 platforms.
! '2vuy' is the Apple QuickTime four-character code for this pixel format.
! The equivalent Microsoft fourCC is 'UYVY'.</dd>
! <dt><code>ARGL_PIX_FORMAT_yuvs</code></dt><dd>8-bit 4:2:2 Component Y'CbCr format. Identical to the ARGL_PIX_FORMAT_2vuy except
! each 16 bit word has been byte swapped. This results in a component
! ordering of; Y0, Cb, Y1, Cr.
! This is most prevalent yuv 4:2:2 format on both Mac and Win32 platforms.
! 'yuvs' is the Apple QuickTime four-character code for this pixel format.
! The equivalent Microsoft fourCC is 'YUY2'.</dd>
! </dl>
! </blockquote>
! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>ARToolKit functions can accept pixel data in a variety of formats.
! This enumerations provides a set of constants you can use to request
! data in a particular pixel format from an ARToolKit function that
! returns data to you, or to specify that data you are providing to an
! ARToolKit function is in a particular pixel format.
! </p>
! </dl>
! <h2>Globals</h2>
! <hr><!-- headerDoc=data; uid=//apple_ref/doc/compositePage/c/data/arglDrawMode; name=arglDrawMode -->
! <a name="//apple_ref/doc/compositePage/c/data/arglDrawMode"></a>
! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglDrawMode">arglDrawMode</a></h3>
! </td></tr></table><hr><dl></dl><p>Determines display method by which arglDispImage() transfers pixels.
! </p>
! <blockquote><pre><font class="keyword">extern</font> <!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <font class="var">arglDrawMode</font>; </pre></blockquote>
! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>The value of this variable determines the method by which
! arglDispImage transfers pixels of an image to the display. Setting this
! variable to a value of AR_DRAW_BY_GL_DRAW_PIXELS specifies the use of OpenGL
! DrawPixels to do the transfer. Setting this variable to a value of
! AR_DRAW_BY_TEXTURE_MAPPING specifies the use of OpenGL TexImage2D to do the
! transfer. The DrawPixels method is guaranteed to be available on all
! implementations, but arglDispImage does not correct the image
! for camera lens distortion under this method. In contrast, TexImage2D is only
! available on some implementations, but allows arglDispImage() to apply a correction
! for camera lens distortion, and additionally offers greater potential for
! accelerated drawing on some implementations.
! <br><br>
! The initial value is defined to the value of the symbolic constant DEFAULT_DRAW_MODE
! (defined in <AR/config.h>).
! </p>
! <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
! </dd>
! </dl>
! <hr><!-- headerDoc=data; uid=//apple_ref/doc/compositePage/c/data/arglTexmapMode; name=arglTexmapMode -->
! <a name="//apple_ref/doc/compositePage/c/data/arglTexmapMode"></a>
! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglTexmapMode">arglTexmapMode</a></h3>
</td></tr></table><hr><dl></dl><p>Determines use of full or half-resolution TexImage2D pixel-transfer in arglDispImage().
</p>
! <blockquote><pre><font class="keyword">extern</font> <!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <font class="var">arglTexmapMode</font>; </pre></blockquote>
! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>When arglDrawMode is set to AR_DRAW_BY_TEXTURE_MAPPING, the value of this variable
determines whether full or half-resolution data is transferred to the
texture. A value of AR_DRAW_TEXTURE_FULL_IMAGE uses all available pixels in the
--- 468,480 ----
</dd>
</dl>
! <hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglTexmapModeSet; name=arglTexmapModeSet -->
! <a name="//apple_ref/doc/compositePage/c/func/arglTexmapModeSet"></a>
! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglTexmapModeSet">arglTexmapModeSet</a></h3>
</td></tr></table><hr><dl></dl><p>Determines use of full or half-resolution TexImage2D pixel-transfer in arglDispImage().
</p>
! <blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/void //apple_ref/c/cl/void //apple_ref/c/tdef/void //apple_ref/c/tag/void //apple_ref/c/econst/void //apple_ref/c/struct/void //apple_ref/c/clconst/void" --><font class="type">void</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglTexmapModeSet //apple_ref/c/clm/arglTexmapModeSet //apple_ref/c/intfcm/arglTexmapModeSet //apple_ref/c/func/arglTexmapModeSet //apple_ref/c/ftmplt/arglTexmapModeSet //apple_ref/c/defn/arglTexmapModeSet //apple_ref/c/macro/arglTexmapModeSet" --><font class="function">arglTexmapModeSet</font><!-- /a -->(
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
! <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <font class="param">mode</font>); </pre></blockquote>
! <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>When arglDrawModeSet(AR_DRAW_BY_TEXTURE_MAPPING) has been called, the value of this setting
determines whether full or half-resolution data is transferred to the
texture. A value of AR_DRAW_TEXTURE_FULL_IMAGE uses all available pixels in the
***************
*** 559,572 ****
The latter method is well-suited to drawing interlaced images, as would be obtained
from DV camera sources in interlaced mode or composite video sources.
</p>
<dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
</dd>
</dl>
! <hr><!-- headerDoc=data; uid=//apple_ref/doc/compositePage/c/data/arglTexRectangle; name=arglTexRectangle -->
! <a name="//apple_ref/doc/compositePage/c/data/arglTexRectangle"></a>
! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglTexRectangle">arglTexRectangle</a></h3>
</td></tr></table><hr><dl></dl><p>Determines use of rectangular TexImage2D pixel-transfer in arglDispImage().
</p>
! <blockquote><pre><font class="keyword">extern</font> <!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <font class="var">arglTexRectangle</font>; </pre></blockquote>
<dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>On implementations which support the OpenGL extension for rectangular textures (of
non power-of-two size), and when arglDrawMode is set to AR_DRAW_BY_TEXTURE_MAPPING,
--- 485,502 ----
The latter method is well-suited to drawing interlaced images, as would be obtained
from DV camera sources in interlaced mode or composite video sources.
+ <br><br>
+ The initial value is AR_DRAW_TEXTURE_FULL_IMAGE.
</p>
<dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
</dd>
</dl>
! <hr><!-- headerDoc=func; uid=//apple_ref/doc/compositePage/c/func/arglTexRectangleSet; name=arglTexRectangleSet -->
! <a name="//apple_ref/doc/compositePage/c/func/arglTexRectangleSet"></a>
! <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="arglTexRectangleSet">arglTexRectangleSet</a></h3>
</td></tr></table><hr><dl></dl><p>Determines use of rectangular TexImage2D pixel-transfer in arglDispImage().
</p>
! <blockquote><pre><!-- a logicalPath="//apple_ref/c/cl/void //apple_ref/c/cl/void //apple_ref/c/tdef/void //apple_ref/c/tag/void //apple_ref/c/econst/void //apple_ref/c/struct/void //apple_ref/c/clconst/void" --><font class="type">void</font><!-- /a --> <!-- a logicalPath="//apple_ref/c/instm/arglTexRectangleSet //apple_ref/c/clm/arglTexRectangleSet //apple_ref/c/intfcm/arglTexRectangleSet //apple_ref/c/func/arglTexRectangleSet //apple_ref/c/ftmplt/arglTexRectangleSet //apple_ref/c/defn/arglTexRectangleSet //apple_ref/c/macro/arglTexRectangleSet" --><font class="function">arglTexRectangleSet</font><!-- /a -->(
! <!-- a logicalPath="//apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/cl/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tdef/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/tag/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/econst/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/struct/ARGL_CONTEXT_SETTINGS_REF //apple_ref/c/clconst/ARGL_CONTEXT_SETTINGS_REF" --><font class="type">ARGL_CONTEXT_SETTINGS_REF</font><!-- /a --> <font class="param">contextSettings</font>,
! <font class="keyword">const</font> <!-- a logicalPath="//apple_ref/c/cl/int //apple_ref/c/cl/int //apple_ref/c/tdef/int //apple_ref/c/tag/int //apple_ref/c/econst/int //apple_ref/c/struct/int //apple_ref/c/clconst/int" --><font class="type">int</font><!-- /a --> <font class="param">state</font>); </pre></blockquote>
<dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>On implementations which support the OpenGL extension for rectangular textures (of
non power-of-two size), and when arglDrawMode is set to AR_DRAW_BY_TEXTURE_MAPPING,
***************
*** 582,585 ****
--- 512,543 ----
</dd>
</dl>
+ <h2>Typedefs</h2>
+ <hr><!-- headerDoc=tdef; uid=//apple_ref/doc/compositePage/c/tdef/ARGL_CONTEXT_SETTINGS_REF; name=ARGL_CONTEXT_SETTINGS_REF -->
+ <a name="//apple_ref/doc/compositePage/c/tdef/ARGL_CONTEXT_SETTINGS_REF"></a>
+ <table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"><h3><a name="ARGL_CONTEXT_SETTINGS_REF">ARGL_CONTEXT_SETTINGS_REF</a></h3>
+ </td></tr></table><hr><dl></dl><p>Opaque type to hold ARGL settings for a given OpenGL context.
+ </p>
+ <blockquote><pre><font class="keyword">typedef</font> <font class="keyword">struct</font> <!-- a logicalPath="//apple_ref/c/cl/_ARGL_CONTEXT_SETTINGS //apple_ref/c/cl/_ARGL_CONTEXT_SETTINGS //apple_ref/c/tdef/_ARGL_CONTEXT_SETTINGS //apple_ref/c/tag/_ARGL_CONTEXT_SETTINGS //apple_ref/c/econst/_ARGL_CONTEXT_SETTINGS //apple_ref/c/struct/_ARGL_CONTEXT_SETTINGS //apple_ref/c/clconst/_ARGL_CONTEXT_SETTINGS" --><font class="type">_ARGL_CONTEXT_SETTINGS</font><!-- /a --> <font class="type">*</font><font class="var">ARGL_CONTEXT_SETTINGS_REF</font>; </pre></blockquote>
+ <dl><h5><font face="Lucida Grande,Helvetica,Arial">Discussion</font></h5><p>An OpenGL context is an implementation-defined structure which
+ keeps track of OpenGL state, including textures and display lists.
+ Typically, individual OpenGL windows will have distinct OpenGL
+ contexts assigned to them by the host operating system.
+ <br><br>
+ As gsub_lite uses textures and display lists, it must be able to
+ track which OpenGL context a given texture or display list it is using
+ belongs to. This is especially important when gsub_lite is being used to
+ draw into more than one window (and therefore more than one context.)
+ <br><br>
+ Basically, functions which depend on OpenGL state, will require an
+ ARGL_CONTEXT_SETTINGS_REF to be passed to them. An ARGL_CONTEXT_SETTINGS_REF
+ is generated by setting the current OpenGL context (e.g. if using GLUT,
+ you might call glutSetWindow()) and then calling arglSetupForCurrentContext().
+ When you have finished using ARGL in a given context, you should call
+ arglCleanup(), passing in an ARGL_CONTEXT_SETTINGS_REF, to free the
+ memory used by the settings structure.
+ </p>
+ <dt><i>Availability</i></dt><dd>First appeared in ARToolKit 2.68.
+ </dd>
+ </dl>
<p><p>© 2003-2005 Philip Lamb
(Last Updated August 29, 2005)
|