Public Member Functions | Static Public Member Functions | Public Attributes

OpenGLPixelFormat Class Reference

Represents the various properties of an OpenGL bitmap format. More...

List of all members.

Public Member Functions

 OpenGLPixelFormat (int bitsPerRGBComponent=8, int alphaBits=8, int depthBufferBits=16, int stencilBufferBits=0)
 Creates an OpenGLPixelFormat.
 OpenGLPixelFormat (const OpenGLPixelFormat &)
OpenGLPixelFormatoperator= (const OpenGLPixelFormat &)
bool operator== (const OpenGLPixelFormat &) const

Static Public Member Functions

static void getAvailablePixelFormats (Component *component, OwnedArray< OpenGLPixelFormat > &results)
 Returns a list of all the pixel formats that can be used in this system.

Public Attributes

int redBits
 The number of bits per pixel to use for the red channel.
int greenBits
 The number of bits per pixel to use for the green channel.
int blueBits
 The number of bits per pixel to use for the blue channel.
int alphaBits
 The number of bits per pixel to use for the alpha channel.
int depthBufferBits
 The number of bits per pixel to use for a depth buffer.
int stencilBufferBits
 The number of bits per pixel to use for a stencil buffer.
int accumulationBufferRedBits
 The number of bits per pixel to use for an accumulation buffer's red channel.
int accumulationBufferGreenBits
 The number of bits per pixel to use for an accumulation buffer's green channel.
int accumulationBufferBlueBits
 The number of bits per pixel to use for an accumulation buffer's blue channel.
int accumulationBufferAlphaBits
 The number of bits per pixel to use for an accumulation buffer's alpha channel.
uint8 fullSceneAntiAliasingNumSamples
 The number of samples to use in full-scene anti-aliasing (if available).

Detailed Description

Represents the various properties of an OpenGL bitmap format.

See also:
OpenGLComponent::setPixelFormat

Constructor & Destructor Documentation

OpenGLPixelFormat::OpenGLPixelFormat ( int  bitsPerRGBComponent = 8,
int  alphaBits = 8,
int  depthBufferBits = 16,
int  stencilBufferBits = 0 
)

Creates an OpenGLPixelFormat.

The default constructor just initialises the object as a simple 8-bit RGBA format.

OpenGLPixelFormat::OpenGLPixelFormat ( const OpenGLPixelFormat  )

Member Function Documentation

OpenGLPixelFormat& OpenGLPixelFormat::operator= ( const OpenGLPixelFormat  )
bool OpenGLPixelFormat::operator== ( const OpenGLPixelFormat  ) const
static void OpenGLPixelFormat::getAvailablePixelFormats ( Component component,
OwnedArray< OpenGLPixelFormat > &  results 
) [static]

Returns a list of all the pixel formats that can be used in this system.

A reference component is needed in case there are multiple screens with different capabilities - in which case, the one that the component is on will be used.


Member Data Documentation

The number of bits per pixel to use for the red channel.

The number of bits per pixel to use for the green channel.

The number of bits per pixel to use for the blue channel.

The number of bits per pixel to use for the alpha channel.

The number of bits per pixel to use for a depth buffer.

The number of bits per pixel to use for a stencil buffer.

The number of bits per pixel to use for an accumulation buffer's red channel.

The number of bits per pixel to use for an accumulation buffer's green channel.

The number of bits per pixel to use for an accumulation buffer's blue channel.

The number of bits per pixel to use for an accumulation buffer's alpha channel.

The number of samples to use in full-scene anti-aliasing (if available).


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines