+\func{void}{wxGLCanvas}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id = wxID\_ANY},
+ \param{int*}{ attribList = 0},
+ \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},
+ \param{long}{ style=0}, \param{const wxString\& }{name="GLCanvas"},
+ \param{const wxPalette\&}{ palette = wxNullPalette}}
+
+Constructors.
+The first three constructors implicitly create an instance of \helpref{wxGLContext}{wxglcontext}.
+The fourth constructur is identical to the first, except for the fact that it does \emph{not}
+create such an implicit rendering context, which means that you have to create an explicit instance
+of \helpref{wxGLContext}{wxglcontext} yourself (highly recommended for future compatibility with wxWidgets
+and the flexibility of your own program!).
+
+Note that if you used one of the first three constructors, \helpref{wxGLCanvas::GetContext}{wxglcanvasgetcontext}
+returns the pointer to the implicitly created instance, and the \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrent}
+method \emph{without} the parameter should be used.
+If however you used the fourth constructor, \helpref{wxGLCanvas::GetContext}{wxglcanvasgetcontext} always returns NULL
+and the \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrentrc} method \emph{with} the parameter must be used!
+
+\docparam{parent}{Pointer to a parent window.}
+
+\docparam{sharedContext}{Context to share object resources with.}
+
+%TODO document sharedCanvas meaning
+
+\docparam{id}{Window identifier. If -1, will automatically create an identifier.}
+
+\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets
+should generate a default position for the window.}
+
+\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets should
+generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized.}
+
+\docparam{style}{Window style.}
+
+\docparam{name}{Window name.}
+
+\docparam{attribList}{Array of int. With this parameter you can set the device context attributes associated to this window.
+This array is zero-terminated: it should be set up with constants described in the table above.
+If a constant should be followed by a value, put it in the next array position.
+For example, the WX\_GL\_DEPTH\_SIZE should be followed by the value that indicates the number of
+bits for the depth buffer, so:}
+
+\begin{verbatim}
+attribList[index]= WX_GL_DEPTH_SIZE;
+attribList[index+1]=32;
+and so on.
+\end{verbatim}
+
+\docparam{palette}{If the window has the palette, it should by pass this value.
+Note: palette and WX\_GL\_RGBA are mutually exclusive.}
+
+
+\membersection{wxGLCanvas::GetContext}\label{wxglcanvasgetcontext}
+
+\func{wxGLContext*}{GetContext}{\void}
+
+Obtains the context that is associated with this canvas if one was implicitly created (by use of one of the first three constructors).
+Always returns NULL if the canvas was constructed with the fourth constructor.
+
projects / wxWidgets.git / blobdiff