# FrameBufferProperties

from pandac.PandaModules import FrameBufferProperties

Class : FrameBufferProperties
Description : A container for the various kinds of properties we might ask to have on a graphics frameBuffer before we create a GSG.

## Inheritance:

FrameBufferProperties:

## Methods of FrameBufferProperties:

addProperties
clear
clearAlphaBits
clearAuxFloat
clearAuxHrgba
clearAuxRgba
clearColorBits
clearDepthBits
clearFrameBufferMode
clearMultisamples
clearStencilBits
getAlphaBits
getAuxFloat
getAuxHrgba
getAuxRgba
getBufferMask
getColorBits
getDefault
getDepthBits
getFrameBufferMode
getMultisamples
getStencilBits
hasAlphaBits
hasAuxFloat
hasAuxHrgba
hasAuxRgba
hasColorBits
hasDepthBits
hasFrameBufferMode
hasMode
hasMultisamples
hasStencilBits
isAnySpecified
isSingleBuffered
isStereo
operator !=
operator =
operator ==
output
setAlphaBits
setAuxFloat
setAuxHrgba
setAuxRgba
setColorBits
setDepthBits
setFrameBufferMode
setMultisamples
setSpecified
setStencilBits
subsumes

## Constants in FrameBufferProperties:

FMRgb | (FrameBufferMode)
FMIndex | (FrameBufferMode)
FMSingleBuffer | (FrameBufferMode)
FMDoubleBuffer | (FrameBufferMode)
FMTripleBuffer | (FrameBufferMode)
FMBuffer | (FrameBufferMode)
FMAccum | (FrameBufferMode)
FMAlpha | (FrameBufferMode)
FMRgba | (FrameBufferMode)
FMDepth | (FrameBufferMode)
FMStencil | (FrameBufferMode)
FMMultisample | (FrameBufferMode)
FMStereo | (FrameBufferMode)
FMSoftware | (FrameBufferMode)
FMHardware | (FrameBufferMode)

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.

clearAlphaBits void FrameBufferProperties::clear_alpha_bits(void); Description: Removes the alpha_bits specification from the properties.

clearAuxFloat void FrameBufferProperties::clear_aux_float(void); Description: Removes the aux_float specification from the properties.

clearAuxHrgba void FrameBufferProperties::clear_aux_hrgba(void); Description: Removes the aux_hrgba specification from the properties.

clearAuxRgba void FrameBufferProperties::clear_aux_rgba(void); Description: Removes the aux_rgba specification from the properties.

clearColorBits void FrameBufferProperties::clear_color_bits(void); Description: Removes the color_bits specification from the properties.

clearDepthBits void FrameBufferProperties::clear_depth_bits(void); Description: Removes the depth_bits specification from the properties.

clearFrameBufferMode void FrameBufferProperties::clear_frame_buffer_mode(void); Description: Removes the frameBuffer_mode specification from the properties.

clearMultisamples void FrameBufferProperties::clear_multisamples(void); Description: Removes the multisamples specification from the properties.

clearStencilBits void FrameBufferProperties::clear_stencil_bits(void); Description: Removes the stencil_bits specification from the properties.

getAlphaBits int FrameBufferProperties::get_alpha_bits(void) const; Description: Returns the number of bits specified for the alpha buffer.

getAuxFloat int FrameBufferProperties::get_aux_float(void) const; Description: Returns the exact number of auxiliary float single-channel bitplanes that are required.

getAuxHrgba int FrameBufferProperties::get_aux_hrgba(void) const; Description: Returns the exact number of auxiliary half-float RGBA bitplanes that are required.

getAuxRgba int FrameBufferProperties::get_aux_rgba(void) const; Description: Returns the exact number of auxiliary RGBA bitplanes that are required.

getBufferMask int FrameBufferProperties::get_buffer_mask(void) const; Description: Returns the buffer mask for the bitplanes in the frame buffer.

getColorBits int FrameBufferProperties::get_color_bits(void) const; Description: Returns the number of bits specified for the color buffer.

getDefault static FrameBufferProperties 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; Description: Returns the number of bits specified for the depth buffer.

getFrameBufferMode int FrameBufferProperties::get_frame_buffer_mode(void) const; Description: Returns the set of graphics properties that are in effect for the window. This will be the union of the corresponding bits from FrameBufferMode.

getMultisamples int FrameBufferProperties::get_multisamples(void) const; Description: Returns the number of samples specified for the multisample buffer.

getStencilBits int FrameBufferProperties::get_stencil_bits(void) const; Description: Returns the number of bits specified for the stencil buffer.

hasAlphaBits bool FrameBufferProperties::has_alpha_bits(void) const; Description: Returns true if the number of bits for the alpha buffer has been specified, false otherwise.

hasAuxFloat bool FrameBufferProperties::has_aux_float(void) const; Description: Returns true if the number of auxiliary float single-channel bitplanes has been specified, false otherwise.

hasAuxHrgba bool FrameBufferProperties::has_aux_hrgba(void) const; Description: Returns true if the number of auxiliary half-float RGBA bitplanes has been specified, false otherwise.

hasAuxRgba bool FrameBufferProperties::has_aux_rgba(void) const; Description: Returns true if the number auxiliary RGBA bitplanes has been specified, false otherwise.

hasColorBits bool FrameBufferProperties::has_color_bits(void) const; Description: Returns true if the number of bits for the color buffer has been specified, false otherwise.

hasDepthBits bool FrameBufferProperties::has_depth_bits(void) const; Description: Returns true if the number of bits for the depth buffer has been specified, false otherwise.

hasFrameBufferMode bool FrameBufferProperties::has_frame_buffer_mode(void) const; Description: Returns true if the frameBuffer mode has been specified, false otherwise.

hasMode bool FrameBufferProperties::has_mode(int bit) const; Description: Returns true if the frame buffer mode, logically anded with the given mask, is nonzero. This is a convenience function to access this useful tidbit of data.

hasMultisamples bool FrameBufferProperties::has_multisamples(void) const; Description: Returns true if the number of bits for the multisample buffer has been specified, false otherwise.

hasStencilBits bool FrameBufferProperties::has_stencil_bits(void) const; Description: Returns true if the number of bits for the stencil buffer has been specified, false otherwise.

isAnySpecified bool FrameBufferProperties::is_any_specified(void) const; Description: Returns true if any properties have been specified, false otherwise.

isSingleBuffered bool FrameBufferProperties::is_single_buffered(void) const; Description: Returns true if the frame buffer indicates a single-buffered mode, false if it indicates double- or triple-buffering. This is a convenience function to access this useful tidbit of data.

isStereo bool FrameBufferProperties::is_stereo(void) const; Description: Returns true if the frame buffer indicates a hardware stereo mode, false otherwise. This is a convenience function to access this useful tidbit of data.

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.

setAlphaBits void FrameBufferProperties::set_alpha_bits(int alpha_bits); Description: Specifies the minimum number of bits that are required of the alpha buffer.

setAuxFloat void FrameBufferProperties::set_aux_float(int naux); Description: Specifies the exact number of auxiliary float single-channel bitplanes that are required.

setAuxHrgba void FrameBufferProperties::set_aux_hrgba(int naux); Description: Specifies the exact number of auxiliary half-float RGBA bitplanes that are required.

setAuxRgba void FrameBufferProperties::set_aux_rgba(int naux); Description: Specifies the exact number of auxiliary RGBA bitplanes that are required.

setColorBits void FrameBufferProperties::set_color_bits(int color_bits); Description: Specifies the minimum number of bits that are required for all three channels of the color buffer. That is, this is the per-channel color requirement times three.

setDepthBits void FrameBufferProperties::set_depth_bits(int depth_bits); Description: Specifies the minimum number of bits that are required for the depth buffer.

setFrameBufferMode void FrameBufferProperties::set_frame_buffer_mode(int frameBuffer_mode); Description: Specifies the set of graphics properties that are required for the context associated with the window. This should be the union of the appropriate bits defined in FrameBufferMode.

setMultisamples void FrameBufferProperties::set_multisamples(int multisamples); Description: Specifies the minimum number of samples that are required for the multisample buffer.

setSpecified void FrameBufferProperties::set_specified(void); Description: Sets all the specified bits. Effectively, this causes the default values to be specified for all not-yet-specified fields.

setStencilBits void FrameBufferProperties::set_stencil_bits(int stencil_bits); Description: Specifies the minimum number of bits that are required for the stencil buffer.

subsumes bool FrameBufferProperties::subsumes(FrameBufferProperties const &prop) 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.