docs/latex/wx/glcanvas.tex

   1 \section{\class{wxGLCanvas}}\label{wxglcanvas}
   2
   3 wxGLCanvas is a class for displaying OpenGL graphics. There are
   4 wrappers for OpenGL on Windows, and GTK+ and Motif.
   5
   6 To use this class, create a wxGLCanvas window, call \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrent}
   7 to direct normal OpenGL commands to the window, and then call \helpref{wxGLCanvas::SwapBuffers}{wxglcanvasswapbuffers}
   8 to show the OpenGL buffer on the window.
   9
  10 To set up the attributes for the rendering context (number of bits for the depth buffer,
  11 number of bits for the stencil buffer and so on) you should set up the correct values of
  12 the {\it attribList} parameter. The values that should be set up and their meanings will be described below.
  13
  14 To switch wxGLCanvas support on under Windows, edit setup.h and set
  15 {\tt wxUSE\_GLCANVAS} to $1$. You may also need to have to add
  16 {\tt opengl32.lib} to the list of libraries your program is linked with. On
  17 Unix, pass {\tt --with-opengl} to configure to compile using OpenGL or Mesa.
  18
  19 \wxheading{Derived from}
  20
  21 \helpref{wxWindow}{wxwindow}\\
  22 \helpref{wxEvtHandler}{wxevthandler}\\
  23 \helpref{wxObject}{wxobject}
  24
  25 \wxheading{Include files}
  26
  27 <wx/glcanvas.h>
  28
  29 \wxheading{Window styles}
  30
  31 There are no specific window styles for this class.
  32
  33 See also \helpref{window styles overview}{windowstyles}.
  34
  35 \wxheading{Constants}
  36
  37 The generic GL implementation doesn't support many of these options, such as stereo, auxiliary buffers,
  38 alpha channel, and accum buffer. Other implementations may support them.
  39
  40 \twocolwidtha{5cm}
  41 \begin{twocollist}\itemsep=0pt
  42 \twocolitem{\windowstyle{WX\_GL\_RGBA}}{Use true colour}
  43 \twocolitem{\windowstyle{WX\_GL\_BUFFER\_SIZE}}{Bits for buffer if not WX\_GL\_RGBA}
  44 \twocolitem{\windowstyle{WX\_GL\_LEVEL}}{0 for main buffer, >0 for overlay, <0 for underlay}
  45 \twocolitem{\windowstyle{WX\_GL\_DOUBLEBUFFER}}{Use doublebuffer}
  46 \twocolitem{\windowstyle{WX\_GL\_STEREO}}{Use stereoscopic display}
  47 \twocolitem{\windowstyle{WX\_GL\_AUX\_BUFFERS}}{Number of auxiliary buffers (not all implementation support this option)}
  48 \twocolitem{\windowstyle{WX\_GL\_MIN\_RED}}{Use red buffer with most bits (> MIN\_RED bits)}
  49 \twocolitem{\windowstyle{WX\_GL\_MIN\_GREEN}}{Use green buffer with most bits (> MIN\_GREEN bits) }
  50 \twocolitem{\windowstyle{WX\_GL\_MIN\_BLUE}}{Use blue buffer with most bits (> MIN\_BLUE bits) }
  51 \twocolitem{\windowstyle{WX\_GL\_MIN\_ALPHA}}{Use alpha buffer with most bits (> MIN\_ALPHA bits)}
  52 \twocolitem{\windowstyle{WX\_GL\_DEPTH\_SIZE}}{Bits for Z-buffer (0,16,32)}
  53 \twocolitem{\windowstyle{WX\_GL\_STENCIL\_SIZE}}{Bits for stencil buffer}
  54 \twocolitem{\windowstyle{WX\_GL\_MIN\_ACCUM\_RED}}{Use red accum buffer with most bits (> MIN\_ACCUM\_RED bits)}
  55 \twocolitem{\windowstyle{WX\_GL\_MIN\_ACCUM\_GREEN}}{Use green buffer with most bits (> MIN\_ACCUM\_GREEN bits)}
  56 \twocolitem{\windowstyle{WX\_GL\_MIN\_ACCUM\_BLUE}}{Use blue buffer with most bits (> MIN\_ACCUM\_BLUE bits)}
  57 \twocolitem{\windowstyle{WX\_GL\_MIN\_ACCUM\_ALPHA}}{Use blue buffer with most bits (> MIN\_ACCUM\_ALPHA bits)}
  58 \end{twocollist}
  59
  60 \wxheading{See also}
  61
  62 \helpref{wxGLContext}{wxglcontext}
  63
  64 \latexignore{\rtfignore{\wxheading{Members}}}
  65
  66
  67 \membersection{wxGLCanvas::wxGLCanvas}\label{wxglcanvasconstr}
  68
  69 \func{void}{wxGLCanvas}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id = -1},
  70  \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},
  71  \param{long}{ style=0}, \param{const wxString\& }{name="GLCanvas"},
  72  \param{int*}{ attribList = 0}, \param{const wxPalette\&}{ palette = wxNullPalette}}
  73
  74 \func{void}{wxGLCanvas}{\param{wxWindow* }{parent}, \param{wxGLContext* }{sharedContext}, \param{wxWindowID}{ id = -1},
  75  \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},
  76  \param{long}{ style=0}, \param{const wxString\& }{name="GLCanvas"},
  77  \param{int*}{ attribList = 0}, \param{const wxPalette\&}{ palette = wxNullPalette}}
  78
  79 \func{void}{wxGLCanvas}{\param{wxWindow* }{parent}, \param{wxGLCanvas* }{sharedCanvas}, \param{wxWindowID}{ id = -1},
  80  \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},
  81  \param{long}{ style=0}, \param{const wxString\& }{name="GLCanvas"},
  82  \param{int*}{ attribList = 0}, \param{const wxPalette\&}{ palette = wxNullPalette}}
  83
  84 Constructor.
  85
  86 \docparam{parent}{Pointer to a parent window.}
  87
  88 \docparam{sharedContext}{Context to share object resources with.}
  89
  90 %TODO document sharedCanvas meaning
  91
  92 \docparam{id}{Window identifier. If -1, will automatically create an identifier.}
  93
  94 \docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets
  95 should generate a default position for the window.}
  96
  97 \docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets should
  98 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.}
  99
 100 \docparam{style}{Window style.}
 101
 102 \docparam{name}{Window name.}
 103
 104 \docparam{attribList}{Array of int. With this parameter you can set the device context attributes associated to this window.
 105 This array is zero-terminated: it should be set up with constants described in the table above.
 106 If a constant should be followed by a value, put it in the next array position.
 107 For example, the WX\_GL\_DEPTH\_SIZE should be followed by the value that indicates the number of
 108 bits for the depth buffer, so:}
 109
 110 \begin{verbatim}
 111 attribList[index]= WX_GL_DEPTH_SIZE;
 112 attribList[index+1]=32;
 113 and so on.
 114 \end{verbatim}
 115
 116 \docparam{palette}{If the window has the palette, it should by pass this value.
 117 Note: palette and WX\_GL\_RGBA are mutually exclusive.}
 118
 119
 120 \membersection{wxGLCanvas::GetContext}\label{wxglcanvasgetcontext}
 121
 122 \func{wxGLContext*}{GetContext}{\void}
 123
 124 Obtains the context that is associated with this canvas.
 125
 126
 127 \membersection{wxGLCanvas::SetCurrent}\label{wxglcanvassetcurrent}
 128
 129 \func{void}{SetCurrent}{\void}
 130
 131 Sets this canvas as the current recipient of OpenGL calls.
 132 Each canvas contains an OpenGL device context that has been created during
 133 the creation of this window. So this call sets the current device context
 134 as the target device context for OpenGL operations.
 135
 136 Note that this function may only be called after the window has been shown.
 137
 138
 139 \membersection{wxGLCanvas::SetColour}\label{wxglcanvassetcolour}
 140
 141 \func{void}{SetColour}{\param{const char*}{ colour}}
 142
 143 Sets the current colour for this window, using the wxWidgets colour database to find a named colour.
 144
 145
 146 \membersection{wxGLCanvas::SwapBuffers}\label{wxglcanvasswapbuffers}
 147
 148 \func{void}{SwapBuffers}{\void}
 149
 150 Displays the previous OpenGL commands on the window.
 151