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

Public Member Functions

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

Public Attributes

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

Detailed Description

Represents the various properties of an OpenGL pixel format.

See also
OpenGLContext::setPixelFormat

Constructor & Destructor Documentation

◆ OpenGLPixelFormat()

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

Creates an OpenGLPixelFormat.

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

Member Function Documentation

◆ operator==()

bool OpenGLPixelFormat::operator== ( const OpenGLPixelFormat ) const
noexcept

◆ operator!=()

bool OpenGLPixelFormat::operator!= ( const OpenGLPixelFormat ) const
noexcept

Member Data Documentation

◆ redBits

int OpenGLPixelFormat::redBits

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

◆ greenBits

int OpenGLPixelFormat::greenBits

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

◆ blueBits

int OpenGLPixelFormat::blueBits

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

◆ alphaBits

int OpenGLPixelFormat::alphaBits

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

◆ depthBufferBits

int OpenGLPixelFormat::depthBufferBits

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

◆ stencilBufferBits

int OpenGLPixelFormat::stencilBufferBits

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

◆ accumulationBufferRedBits

int OpenGLPixelFormat::accumulationBufferRedBits

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

◆ accumulationBufferGreenBits

int OpenGLPixelFormat::accumulationBufferGreenBits

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

◆ accumulationBufferBlueBits

int OpenGLPixelFormat::accumulationBufferBlueBits

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

◆ accumulationBufferAlphaBits

int OpenGLPixelFormat::accumulationBufferAlphaBits

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

◆ multisamplingLevel

uint8 OpenGLPixelFormat::multisamplingLevel

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


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