FrameBufferProperties

Inheritance:

Methods of FrameBufferProperties:

addProperties
void FrameBufferProperties::add_properties(FrameBufferProperties const &other);

Description: Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged.

clear
void FrameBufferProperties::clear(void);

Description: Unsets all properties that have been specified so far, and resets the FrameBufferProperties structure to its initial empty state.

getAccumBits
int FrameBufferProperties::get_accum_bits(void) const;

Description:

getAlphaBits
int FrameBufferProperties::get_alpha_bits(void) const;

Description:

getAuxFloat
int FrameBufferProperties::get_aux_float(void) const;

Description:

getAuxHrgba
int FrameBufferProperties::get_aux_hrgba(void) const;

Description:

getAuxMask
int FrameBufferProperties::get_aux_mask(void) const;

Description: Converts the aux bitplanes of the framebuffer into a RenderBuffer::Type.

getAuxRgba
int FrameBufferProperties::get_aux_rgba(void) const;

Description:

getBackBuffers
int FrameBufferProperties::get_back_buffers(void) const;

Description:

getBufferMask
int FrameBufferProperties::get_buffer_mask(void) const;

Description: Converts the non-aux bitplanes of the framebuffer into a RenderBuffer::Type.

getColorBits
int FrameBufferProperties::get_color_bits(void) const;

Individual queries.
Description:

getDefault
static FrameBufferProperties const &FrameBufferProperties::get_default(void);

Description: Returns a FrameBufferProperties structure with all of the default values filled in according to the user's config file.

getDepthBits
int FrameBufferProperties::get_depth_bits(void) const;

Individual queries.
Description:

getForceHardware
int FrameBufferProperties::get_force_hardware(void) const;

Description:

getForceSoftware
int FrameBufferProperties::get_force_software(void) const;

Description:

getIndexedColor
int FrameBufferProperties::get_indexed_color(void) const;

Description:

getMultisamples
int FrameBufferProperties::get_multisamples(void) const;

Description:

getQuality
int FrameBufferProperties::get_quality(FrameBufferProperties const &reqs) const;

Description: Assumes that these properties are a description of a window.
Measures how well this window satisfies a specified set of requirements. A higher quality number means that more requirements were satisfied. A quality of zero means that the window is unsuitable.
The routine deducts a lot if the window fails to provide a requested feature. It deducts less if the window provides a feature, but at a degraded level of functionality (ie, the user asks for rgba8, color, but the window only provides rgba4). The routine also deducts a small amount for unnecessary features. For example, if the window has an accumulation buffer when one is not requested will reduce quality slightly. Maximum quality is obtained when the window exactly matches the request.
If you want to know whether the window satisfies all of the requirements, use the "subsumes" function.

getRgbColor
int FrameBufferProperties::get_rgb_color(void) const;

Description:

getStencilBits
int FrameBufferProperties::get_stencil_bits(void) const;

Description:

getStereo
int FrameBufferProperties::get_stereo(void) const;

Description:

isAnySpecified
bool FrameBufferProperties::is_any_specified(void) const;

Description: Returns true if any properties have been specified, false otherwise.

isBasic
bool FrameBufferProperties::is_basic(void) const;

Description: Returns true if the properties are extremely basic. The following count as basic: rgb or rgba, depth. If anything else is specified, the properties are non-basic.

isSingleBuffered
bool FrameBufferProperties::is_single_buffered(void) const;

Description:

isStereo
bool FrameBufferProperties::is_stereo(void) const;

Description:

operator !=
bool FrameBufferProperties::operator !=(FrameBufferProperties const &other) const;

Description:

operator =
void FrameBufferProperties::operator =(FrameBufferProperties const &copy);

Description:

operator ==
bool FrameBufferProperties::operator ==(FrameBufferProperties const &other) const;

Description:

output
void FrameBufferProperties::output(ostream &out) const;

Description: Sets any properties that are explicitly specified in other on this object. Leaves other properties unchanged.

setAccumBits
void FrameBufferProperties::set_accum_bits(int n);

Description:

setAllSpecified
void FrameBufferProperties::set_all_specified(void);

Description: sets all the specified bits.

setAlphaBits
void FrameBufferProperties::set_alpha_bits(int n);

Description:

setAuxFloat
void FrameBufferProperties::set_aux_float(int n);

Description:

setAuxHrgba
void FrameBufferProperties::set_aux_hrgba(int n);

Description:

setAuxRgba
void FrameBufferProperties::set_aux_rgba(int n);

Description:

setBackBuffers
void FrameBufferProperties::set_back_buffers(int n);

Description:

setColorBits
void FrameBufferProperties::set_color_bits(int n);

Individual assigners.
Description:

setDepthBits
void FrameBufferProperties::set_depth_bits(int n);

Individual assigners.
Description:

setForceHardware
void FrameBufferProperties::set_force_hardware(int n);

Description:

setForceSoftware
void FrameBufferProperties::set_force_software(int n);

Description:

setIndexedColor
void FrameBufferProperties::set_indexed_color(int n);

Description:

setMultisamples
void FrameBufferProperties::set_multisamples(int n);

Description:

setOneBitPerChannel
void FrameBufferProperties::set_one_bit_per_channel(void);

Description: If any of the depth, color, alpha, accum, or stencil properties is set to more than one, then they are reduced to one.

setRgbColor
void FrameBufferProperties::set_rgb_color(int n);

Description:

setStencilBits
void FrameBufferProperties::set_stencil_bits(int n);

Description:

setStereo
void FrameBufferProperties::set_stereo(int n);

Description:

subsumes
bool FrameBufferProperties::subsumes(FrameBufferProperties const &other) const;

Description: Returns true if this set of properties makes strictly greater or equal demands of the framebuffer than the other set of framebuffer properties.

verifyHardwareSoftware
bool FrameBufferProperties::verify_hardware_software(FrameBufferProperties const &props, string const &renderer) const;

Description: Validates that the properties represent the desired kind of renderer (hardware or software). If not, prints out an error message and returns false.