Reference Manual

Inti::Gdk::GL::Config Class Reference

A GdkGLConfig C++ wrapper class. More...

#include <inti/gdk/gl/config.h>

List of all members.

Public Member Functions

Constructors

• virtual ~Config ()

  Destructor.
  
  

Accessors

• GdkGLConfig * gdk_gl_config () const

  Get a pointer to the GdkGLConfig structure.
  
  

• GdkGLConfigClass * gdk_gl_config_class () const

  Get a pointer to the GdkGLConfigClass structure.
  
  

• operator GdkGLConfig * () const

  Conversion operator; safely converts a Config to a GdkGLConfig pointer.
  
  

• Gdk::Screen * get_screen () const

  Returns the Gdk::Screen.
  
  

• bool get_attrib (int attribute, int &value)

  Gets information about an OpenGL frame buffer configuration.
  
  

• Gdk::Colormap * get_colormap () const

  Gets the Gdk::Colormap that is appropriate for the OpenGL frame buffer configuration.
  
  

• Gdk::Visual * get_visual () const

  Gets the Gdk::Visual that is appropriate for the OpenGL frame buffer configuration.
  
  

• int get_depth () const

  Gets the color depth of the OpenGL-capable visual.
  
  

• int get_layer_plane () const

  Gets the layer plane (level) of the frame buffer.
  
  

• int get_n_aux_buffers () const

  Gets the number of auxiliary color buffers.
  
  

• int get_n_sample_buffers () const

  Gets the number of multisample buffers.
  
  

• bool is_rgba () const

  Determines whether the configured frame buffer is RGBA mode.
  
  

• bool is_double_buffered () const

  Determines whether the configuration supports the double-buffered visual.
  
  

• bool is_stereo () const

  Determines whether the configuration supports the stereo visual.
  
  

• bool has_alpha () const

  Determines whether the configured color buffer has alpha bits.
  
  

• bool has_depth_buffer () const

  Determines whether the configured frame buffer has depth buffer.
  
  

• bool has_stencil_buffer () const

  Determines whether the configured frame buffer has stencil buffer.
  
  

• bool has_accum_buffer () const

  Determines whether the configured frame buffer has accumulation buffer.
  
  

Static Public Member Functions

• Pointer< Config > create (const int *attrib_list, const Gdk::Screen *screen=0)

  Create an OpenGL frame buffer configuration that matchs the specified attributes.
  
  

• Pointer< Config > create (ConfigModeField mode, const Gdk::Screen *screen=0)

  Create an OpenGL frame buffer configuration that matches the specified display mode.
  
  

Protected Member Functions

Constructors

• Config (GdkGLConfig *config, bool reference=true)

  Construct a new Config from an existing GdkGLConfig.
  
  

---

Detailed Description

A GdkGLConfig C++ wrapper class.

---

Constructor & Destructor Documentation

Inti::Gdk::GL::Config::Config (  GdkGLConfig *  config, bool  reference = true )  [explicit, protected]

Construct a new Config from an existing GdkGLConfig. Parameters: config  A pointer to a GdkGLConfig. reference  Set false if the initial reference count is floating, set true if it's not. The config can be a newly created GdkGLConfig or an existing GdkGLConfig. (see G::Object::Object).

---

Member Function Documentation

Pointer<Config> Inti::Gdk::GL::Config::create (  ConfigModeField  mode, const Gdk::Screen *  screen = 0 )  [static]

Create an OpenGL frame buffer configuration that matches the specified display mode. Parameters: mode  The display mode bit mask. screen  The target screen, or null for the default screen. Returns: A smart pointer to a new Config object, or null if an error occurs.

Pointer<Config> Inti::Gdk::GL::Config::create (  const int *  attrib_list, const Gdk::Screen *  screen = 0 )  [static]

Create an OpenGL frame buffer configuration that matchs the specified attributes. Parameters: attrib_list  An int array that contains the attribute/value pairs. screen  The target screen, or null for the default screen. Returns: A smart pointer to a new Config object, or null if an error occurs. Available attributes are: GDK_GL_USE_GL, GDK_GL_BUFFER_SIZE, GDK_GL_LEVEL, GDK_GL_RGBA, GDK_GL_DOUBLEBUFFER, GDK_GL_STEREO, GDK_GL_AUX_BUFFERS, GDK_GL_RED_SIZE, GDK_GL_GREEN_SIZE, GDK_GL_BLUE_SIZE, GDK_GL_ALPHA_SIZE, GDK_GL_DEPTH_SIZE, GDK_GL_STENCIL_SIZE, GDK_GL_ACCUM_RED_SIZE, GDK_GL_ACCUM_GREEN_SIZE, GDK_GL_ACCUM_BLUE_SIZE, GDK_GL_ACCUM_ALPHA_SIZE. The last attribute in attrib_list must be GDK_GL_ATTRIB_LIST_NONE.

bool Inti::Gdk::GL::Config::get_attrib (  int  attribute, int &  value )

Gets information about an OpenGL frame buffer configuration. Parameters: attribute  The attribute to be returned. value  A reference to the return location for the requested value. Returns: true if successful, false otherwise.

Gdk::Colormap* Inti::Gdk::GL::Config::get_colormap (   )  const

Gets the Gdk::Colormap that is appropriate for the OpenGL frame buffer configuration. Returns: The appropriate Gdk::Colormap.

int Inti::Gdk::GL::Config::get_depth (   )  const

Gets the color depth of the OpenGL-capable visual. Returns: The number of bits per pixel.

int Inti::Gdk::GL::Config::get_layer_plane (   )  const

Gets the layer plane (level) of the frame buffer. Returns: The layer plane. Zero is the default frame buffer. Positive layer planes correspond to frame buffers that overlay the default buffer, and negative layer planes correspond to frame buffers that underlie the default frame buffer.

int Inti::Gdk::GL::Config::get_n_aux_buffers (   )  const

Gets the number of auxiliary color buffers. Returns: The number of auxiliary color buffers.

int Inti::Gdk::GL::Config::get_n_sample_buffers (   )  const

Gets the number of multisample buffers. Returns: The number of multisample buffers.

Gdk::Visual* Inti::Gdk::GL::Config::get_visual (   )  const

Gets the Gdk::Visual that is appropriate for the OpenGL frame buffer configuration. Returns: The appropriate Gdk::Visual.

bool Inti::Gdk::GL::Config::has_accum_buffer (   )  const

Determines whether the configured frame buffer has accumulation buffer. Returns: true if the frame buffer has accumulation buffer, false otherwise.

bool Inti::Gdk::GL::Config::has_alpha (   )  const

Determines whether the configured color buffer has alpha bits. Returns: true if the color buffer has alpha bits, false otherwise.

bool Inti::Gdk::GL::Config::has_depth_buffer (   )  const

Determines whether the configured frame buffer has depth buffer. Returns: true if the frame buffer has depth buffer, false otherwise.

bool Inti::Gdk::GL::Config::has_stencil_buffer (   )  const

Determines whether the configured frame buffer has stencil buffer. Returns: true if the frame buffer has stencil buffer, false otherwise.

bool Inti::Gdk::GL::Config::is_double_buffered (   )  const

Determines whether the configuration supports the double-buffered visual. Returns: true if the double-buffered visual is supported, false otherwise.

bool Inti::Gdk::GL::Config::is_rgba (   )  const

Determines whether the configured frame buffer is RGBA mode. Returns: true if the configured frame buffer is RGBA mode, false otherwise.

bool Inti::Gdk::GL::Config::is_stereo (   )  const

Determines whether the configuration supports the stereo visual. Returns: true if the stereo visual is supported, false otherwise.

---

The documentation for this class was generated from the following file:

• config.h