fix the include files

[wxWidgets.git] / docs / latex / wx / glcanvas.tex

diff --git a/docs/latex/wx/glcanvas.tex b/docs/latex/wx/glcanvas.tex
index 1c2f631b4cf47a91210b6a1487869033b0f29049..b21d6d570291183f2682d5551a19b558b5f1be09 100644 (file)
--- a/docs/latex/wx/glcanvas.tex
+++ b/docs/latex/wx/glcanvas.tex
@@ -40,6 +40,10 @@ your program is linked with). On Unix, pass {\tt --with-opengl} to configure.
 
 <wx/glcanvas.h>
 
 
 <wx/glcanvas.h>
 

+\wxheading{Library}
+
+\helpref{wxGl}{librarieslist}
+

 \wxheading{Window styles}
 
 There are no specific window styles for this class.
 \wxheading{Window styles}
 
 There are no specific window styles for this class.


@@ -58,7 +62,7 @@ alpha channel, and accum buffer. Other implementations may support them.
 \twocolitem{\windowstyle{WX\_GL\_LEVEL}}{0 for main buffer, >0 for overlay, <0 for underlay}
 \twocolitem{\windowstyle{WX\_GL\_DOUBLEBUFFER}}{Use doublebuffer}
 \twocolitem{\windowstyle{WX\_GL\_STEREO}}{Use stereoscopic display}
 \twocolitem{\windowstyle{WX\_GL\_LEVEL}}{0 for main buffer, >0 for overlay, <0 for underlay}
 \twocolitem{\windowstyle{WX\_GL\_DOUBLEBUFFER}}{Use doublebuffer}
 \twocolitem{\windowstyle{WX\_GL\_STEREO}}{Use stereoscopic display}

-\twocolitem{\windowstyle{WX\_GL\_AUX\_BUFFERS}}{Number of auxiliary buffers (not all implementation support this option)}
+\twocolitem{\windowstyle{WX\_GL\_AUX\_BUFFERS}}{Number of auxiliary buffers (not all implementations support this option)}

 \twocolitem{\windowstyle{WX\_GL\_MIN\_RED}}{Use red buffer with most bits (> MIN\_RED bits)}
 \twocolitem{\windowstyle{WX\_GL\_MIN\_GREEN}}{Use green buffer with most bits (> MIN\_GREEN bits) }
 \twocolitem{\windowstyle{WX\_GL\_MIN\_BLUE}}{Use blue buffer with most bits (> MIN\_BLUE bits) }
 \twocolitem{\windowstyle{WX\_GL\_MIN\_RED}}{Use red buffer with most bits (> MIN\_RED bits)}
 \twocolitem{\windowstyle{WX\_GL\_MIN\_GREEN}}{Use green buffer with most bits (> MIN\_GREEN bits) }
 \twocolitem{\windowstyle{WX\_GL\_MIN\_BLUE}}{Use blue buffer with most bits (> MIN\_BLUE bits) }


@@ -121,9 +125,20 @@ and so on.
 Ignored under most platforms.}
 
 
 Ignored under most platforms.}
 
 

+\membersection{wxGLCanvas::IsDisplaySupported}\label{wxglcanvasisdisplaysupported}
+
+\func{static bool}{IsDisplaySupported}{ \param{const int *}{ attribList = \NULL} }
+
+Determines if a canvas having the specified attributes is available.
+
+\docparam{attribList}{See \arg{attribList} for \helpref{wxGLCanvas::wxGLCanvas}{wxglcanvasconstr}.}
+
+Returns \true if attributes are supported.
+
+

 \membersection{wxGLCanvas::SetCurrent}\label{wxglcanvassetcurrent}
 
 \membersection{wxGLCanvas::SetCurrent}\label{wxglcanvassetcurrent}
 

-\func{void}{SetCurrent}{ \param{const wxGLContext&}{ context} }
+\func{bool}{SetCurrent}{ \param{const wxGLContext&}{ context} }

 
 Makes the OpenGL state that is represented by the OpenGL rendering context
 \arg{context} current, i.e. it will be used by all subsequent OpenGL calls.
 
 Makes the OpenGL state that is represented by the OpenGL rendering context
 \arg{context} current, i.e. it will be used by all subsequent OpenGL calls.


@@ -135,6 +150,8 @@ Note that this function may only be called when the window is shown on screen,
 in particular it can't usually be called from the constructor as the window
 isn't yet shown at this moment.
 
 in particular it can't usually be called from the constructor as the window
 isn't yet shown at this moment.
 

+Returns \false if an error occurred.
+

 
 \membersection{wxGLCanvas::SetColour}\label{wxglcanvassetcolour}
 
 
 \membersection{wxGLCanvas::SetColour}\label{wxglcanvassetcolour}
 


@@ -146,8 +163,10 @@ wxWidgets colour database to find a named colour.
 
 \membersection{wxGLCanvas::SwapBuffers}\label{wxglcanvasswapbuffers}
 
 
 \membersection{wxGLCanvas::SwapBuffers}\label{wxglcanvasswapbuffers}
 

-\func{void}{SwapBuffers}{\void}
+\func{bool}{SwapBuffers}{\void}

 
 Swaps the double-buffer of this window, making the back-buffer the front-buffer and vice versa,
 so that the output of the previous OpenGL commands is displayed on the window.
 
 
 Swaps the double-buffer of this window, making the back-buffer the front-buffer and vice versa,
 so that the output of the previous OpenGL commands is displayed on the window.
 

+Returns \false if an error occurred.
+