wxGLCanvaswxGLCanvas is a class for displaying OpenGL graphics. There are two ways to use this class: For the older (before wx 2.7.x) and simpler method, create a wxGLCanvas window using one of the three constructors that implicitly create a rendering context, call wxGLCanvas::SetCurrent to direct normal OpenGL commands to the window, and then call wxGLCanvas::SwapBuffers to show the OpenGL buffer on the window. For the newer (wx 2.7.x+) method, create a wxGLCanvas window using the constructor that does not create an implicit rendering context, create an explicit instance of a wxGLContext that is initialized with the wxGLCanvas yourself, then use either wxGLCanvas::SetCurrent with the instance of the wxGLContext or wxGLContext::SetCurrent with the instance of the wxGLCanvas to bind the OpenGL state that is represented by the rendering context to the canvas, and then call wxGLCanvas::SwapBuffers to swap the buffers of the OpenGL canvas and thus show your current output. To set up the attributes for the canvas (number of bits for the depth buffer, number of bits for the stencil buffer and so on) you should set up the correct values of the attribList parameter. The values that should be set up and their meanings will be described below. To switch on wxGLCanvas support on under Windows, edit setup.h and set wxUSE_GLCANVAS to 1. You may also need to have to add opengl32.lib to the list of libraries your program is linked with. On Unix, pass --with-opengl to configure to compile using OpenGL or Mesa. Derived from
wxWindow Include files <wx/glcanvas.h> Window styles There are no specific window styles for this class. See also window styles overview. Constants The generic GL implementation doesn't support many of these options, such as stereo, auxiliary buffers, alpha channel, and accum buffer. Other implementations may support them.
See also Members
wxGLCanvas::wxGLCanvas
wxGLCanvas::wxGLCanvasvoid wxGLCanvas(wxWindow* parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style=0, const wxString& name="GLCanvas", int* attribList = 0, const wxPalette& palette = wxNullPalette) void wxGLCanvas(wxWindow* parent, wxGLContext* sharedContext, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style=0, const wxString& name="GLCanvas", int* attribList = 0, const wxPalette& palette = wxNullPalette) void wxGLCanvas(wxWindow* parent, wxGLCanvas* sharedCanvas, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style=0, const wxString& name="GLCanvas", int* attribList = 0, const wxPalette& palette = wxNullPalette) void wxGLCanvas(wxWindow* parent, wxWindowID id = wxID_ANY, int* attribList = 0, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style=0, const wxString& name="GLCanvas", const wxPalette& palette = wxNullPalette) Constructors. The first three constructors implicitly create an instance of wxGLContext. The fourth constructur is identical to the first, except for the fact that it does not create such an implicit rendering context, which means that you have to create an explicit instance of 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, wxGLCanvas::GetContext returns the pointer to the implicitly created instance, and the wxGLCanvas::SetCurrent method without the parameter should be used. If however you used the fourth constructor, wxGLCanvas::GetContext always returns NULL and the wxGLCanvas::SetCurrent method with the parameter must be used! parent
sharedContext
id
pos
size
style
name
attribList
attribList[index]= WX_GL_DEPTH_SIZE; attribList[index+1]=32; and so on.palette
wxGLCanvas::GetContextwxGLContext* GetContext() 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.
wxGLCanvas::SetCurrentvoid SetCurrent() If this canvas was created with one of the first three constructors, a call to this method makes the implicit rendering context of this canvas current with this canvas, so that subsequent OpenGL calls modify the OpenGL state of the implicit rendering context. If this canvas was created with the fourth constructor, this method should not be called (use the SetCurrent method below with the parameter instead)! Note that this function may only be called after the window has been shown.
wxGLCanvas::SetCurrentvoid SetCurrent( const wxGLContext RC ) If this canvas was created with one of the first three constructors, this method should not be called (use the SetCurrent above without the parameter instead)! If this canvas was created with the fourth constructor, a call to this method makes the OpenGL state that is represented by the OpenGL rendering context RC current with this canvas, and if win is an object of type wxGLCanvas, the statements win.SetCurrent(RC); and RC.SetCurrent(win); are equivalent, see wxGLContext::SetCurrent. Note that this function may only be called after the window has been shown.
wxGLCanvas::SetColourvoid SetColour(const char* colour) Sets the current colour for this window, using the wxWidgets colour database to find a named colour.
wxGLCanvas::SwapBuffersvoid SwapBuffers() 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.
|