Version: 3.1.2
glcanvas.h File Reference

Classes

class  wxGLAttribsBase
 This is the base class for wxGLAttributes and wxGLContextAttrs. More...
 
class  wxGLAttributes
 This class is used for setting display attributes when drawing through OpenGL ("Pixel format" in MSW and OSX parlance, "Configs" in X11). More...
 
class  wxGLContextAttrs
 This class is used for setting context attributes. More...
 
class  wxGLContext
 An instance of a wxGLContext represents the state of an OpenGL state machine and the connection between OpenGL and the system. More...
 
class  wxGLCanvas
 wxGLCanvas is a class for displaying OpenGL graphics. More...
 

Enumerations

enum  {
  WX_GL_RGBA = 1,
  WX_GL_BUFFER_SIZE,
  WX_GL_LEVEL,
  WX_GL_DOUBLEBUFFER,
  WX_GL_STEREO,
  WX_GL_AUX_BUFFERS,
  WX_GL_MIN_RED,
  WX_GL_MIN_GREEN,
  WX_GL_MIN_BLUE,
  WX_GL_MIN_ALPHA,
  WX_GL_DEPTH_SIZE,
  WX_GL_STENCIL_SIZE,
  WX_GL_MIN_ACCUM_RED,
  WX_GL_MIN_ACCUM_GREEN,
  WX_GL_MIN_ACCUM_BLUE,
  WX_GL_MIN_ACCUM_ALPHA,
  WX_GL_SAMPLE_BUFFERS,
  WX_GL_SAMPLES,
  WX_GL_FRAMEBUFFER_SRGB,
  WX_GL_MAJOR_VERSION,
  WX_GL_MINOR_VERSION,
  WX_GL_CORE_PROFILE,
  wx_GL_COMPAT_PROFILE,
  WX_GL_FORWARD_COMPAT,
  WX_GL_ES2,
  WX_GL_DEBUG,
  WX_GL_ROBUST_ACCESS,
  WX_GL_NO_RESET_NOTIFY,
  WX_GL_LOSE_ON_RESET,
  WX_GL_RESET_ISOLATION,
  WX_GL_RELEASE_FLUSH,
  WX_GL_RELEASE_NONE
}
 

Enumeration Type Documentation

anonymous enum

Constants for use with wxGLCanvas. Most of the constants must be followed by a value. This is indicated by "(F)". Instead of these flags, the use of wxGLAttributes and wxGLContextAttrs is preferred since wxWidgets 3.1.0.

Note
Not all implementations support options such as stereo, auxiliary buffers, alpha channel, and accumulator buffer, use wxGLCanvas::IsDisplaySupported() to check for individual visual attributes support.
Enumerator
WX_GL_RGBA 

Use true color (the default if no attributes at all are specified); do not use a palette.

WX_GL_BUFFER_SIZE 

(F) Specifies the number of bits for colour buffer.

WX_GL_LEVEL 

(F) 0 for main buffer, >0 for overlay, <0 for underlay.

WX_GL_DOUBLEBUFFER 

Use double buffering if present ("on" if no attributes specified).

WX_GL_STEREO 

Use stereoscopic display.

WX_GL_AUX_BUFFERS 

(F) The number of auxiliary buffers.

WX_GL_MIN_RED 

(F) Use red buffer with most bits (> MIN_RED bits)

WX_GL_MIN_GREEN 

(F) Use green buffer with most bits (> MIN_GREEN bits)

WX_GL_MIN_BLUE 

(F) Use blue buffer with most bits (> MIN_BLUE bits)

WX_GL_MIN_ALPHA 

(F) Use alpha buffer with most bits (> MIN_ALPHA bits)

WX_GL_DEPTH_SIZE 

(F) Specifies number of bits for Z-buffer (typically 0, 16 or 32).

WX_GL_STENCIL_SIZE 

(F) Specifies number of bits for stencil buffer.

WX_GL_MIN_ACCUM_RED 

(F) Specifies minimal number of red accumulator bits.

WX_GL_MIN_ACCUM_GREEN 

(F) Specifies minimal number of green accumulator bits.

WX_GL_MIN_ACCUM_BLUE 

(F) Specifies minimal number of blue accumulator bits.

WX_GL_MIN_ACCUM_ALPHA 

(F) Specifies minimal number of alpha accumulator bits.

WX_GL_SAMPLE_BUFFERS 

(F) 1 for multi-sampling support (antialiasing)

WX_GL_SAMPLES 

(F) 4 for 2x2 antialiasing supersampling on most graphics cards

WX_GL_FRAMEBUFFER_SRGB 

Used to request a frame buffer sRGB capable.

Since
3.1.0
WX_GL_MAJOR_VERSION 

(F) Request specific OpenGL core major version number (>= 3).

This attribute should be followed by the major version number requested.

It has no effect under OS X where specifying WX_GL_CORE_PROFILE will result in using OpenGL version at least 3.2 but can still be used there for portability.

Since
3.0.3
WX_GL_MINOR_VERSION 

(F) Request specific OpenGL core minor version number.

This attribute has the same semantics as WX_GL_MAJOR_VERSION but is for the minor OpenGL version, e.g. 2 if OpenGL 3.2 is requested.

Since
3.0.3
WX_GL_CORE_PROFILE 

Request an OpenGL core profile for the context.

If the requested OpenGL version is less than 3.2, this attribute is ignored and the functionality of the context is determined solely by the requested version.

Since
3.0.3
wx_GL_COMPAT_PROFILE 

Request a type of context with all OpenGL features from version 1.0 to the newest available by the GPU driver.

In this mode the GPU may be some slower than it would be without this compatibility attribute.

Since
3.1.0
WX_GL_FORWARD_COMPAT 

Request a forward-compatible context.

Forward-compatible contexts are defined only for OpenGL versions 3.0 and later. They must not support functionality marked as deprecated by that version of the OpenGL API.

Since
3.1.0
WX_GL_ES2 

Request an ES or ES2 ("Embedded Subsystem") context.

These are special subsets of OpenGL, lacking some features of the full specification. Used mainly in embedded devices such as mobile phones.

Since
3.1.0
WX_GL_DEBUG 

Request debugging functionality.

This tells OpenGL to prepare a set where some logs are enabled and also allows OGL to send debug messages through a callback function.

Since
3.1.0
WX_GL_ROBUST_ACCESS 

Request robustness, or how OpenGL handles out-of-bounds buffer object accesses and graphics reset notification behaviours.

Since
3.1.0
WX_GL_NO_RESET_NOTIFY 

With robustness enabled, never deliver notification of reset events.

Since
3.1.0
WX_GL_LOSE_ON_RESET 

With robustness enabled, if graphics reset happens, all context state is lost.

Since
3.1.0
WX_GL_RESET_ISOLATION 

Request OpenGL to protect other apps or shared contexts from reset side-effects.

Since
3.1.0
WX_GL_RELEASE_FLUSH 

Request OpenGL to flush pending commands when the context is released.

Since
3.1.0
WX_GL_RELEASE_NONE 

Request OpenGL to avoid flushing pending commands when the context is released.

Since
3.1.0