Format /

#include “cinder/gl/Fbo.h”

Public Member Functions

Format ()

Default constructor, sets the target to GL_TEXTURE_2D with an 8-bit color+alpha, a 24-bit depth texture, and no multisampling or mipmapping.
Format &

colorTexture (const Texture::Format &textureFormat=getDefaultColorTextureFormat(true))

Enables a color texture at GL_COLOR_ATTACHMENT0 with a Texture::Format of textureFormat , which defaults to 8-bit RGBA with no mipmapping. Disables a color renderbuffer.
Format &

disableColor ()

Disables both a color Texture and a color Buffer .
Format &

depthBuffer (GLenum internalFormat=getDefaultDepthInternalFormat())

Enables a depth renderbuffer with an internal format of internalFormat , which defaults to GL_DEPTH_COMPONENT24 . Disables a depth texture.
Format &

depthTexture (const Texture::Format &textureFormat=getDefaultDepthTextureFormat())

Enables a depth texture with a format of textureFormat , which defaults to GL_DEPTH_COMPONENT24 . Disables a depth renderbuffer.
Format &

disableDepth ()

Disables both a depth Texture and a depth Buffer .
Format &

samples (int samples)

Sets the number of MSAA samples. Defaults to none.
Format &

coverageSamples (int coverageSamples)

Sets the number of CSAA samples. Defaults to none.
Format &

stencilBuffer (bool stencilBuffer=true)

Enables a stencil buffer. Defaults to false.
Format &

attachment (GLenum attachmentPoint, const RenderbufferRef &buffer, RenderbufferRef multisampleBuffer=RenderbufferRef())

Adds a Renderbuffer attachment buffer at attachmentPoint (such as GL_COLOR_ATTACHMENT0 ). Replaces any existing attachment at the same attachment point.
Format &

attachment (GLenum attachmentPoint, const TextureBaseRef &texture, RenderbufferRef multisampleBuffer=RenderbufferRef())

Adds a Texture attachment texture at attachmentPoint (such as GL_COLOR_ATTACHMENT0 ). Replaces any existing attachment at the same attachment point.
void

setDepthBufferInternalFormat (GLint depthInternalFormat)

Sets the internal format for the depth buffer. Defaults to GL_DEPTH_COMPONENT24 . Common options also include GL_DEPTH_COMPONENT16 and GL_DEPTH_COMPONENT32 .
void

setSamples (int samples)

Sets the number of samples used in MSAA-style antialiasing. Defaults to none, disabling multisampling. Note that not all implementations support multisampling.
void

setCoverageSamples (int coverageSamples)

Sets the number of coverage samples used in CSAA-style antialiasing. Defaults to none. Note that not all implementations support CSAA, and is currenlty Windows-only Nvidia. Ignored on OpenGL ES.
void

setColorTextureFormat (const Texture::Format &format)

Sets the Color Texture::Format for use in the creation of the color texture.
void

enableDepthBuffer (bool depthBuffer=true)

Enables or disables the creation of a depth buffer for the FBO.
void

enableStencilBuffer (bool stencilBuffer=true)

Enables or disables the creation of a stencil buffer.
void

removeAttachment (GLenum attachmentPoint)

Removes a buffer or texture attached at attachmentPoint .
GLint

getDepthBufferInternalFormat () const

Returns the GL internal format for the depth buffer. Defaults to GL_DEPTH_COMPONENT24 .
const Texture::Format &

getColorTextureFormat () const

Returns the Texture::Format for the default color texture at GL_COLOR_ATTACHMENT0.
const Texture::Format &

getDepthTextureFormat () const

Returns the Texture::Format for the depth texture.
int

getSamples () const

Returns the number of samples used in MSAA-style antialiasing. Defaults to none, disabling multisampling.
int

getCoverageSamples () const

Returns the number of coverage samples used in CSAA-style antialiasing. Defaults to none. MSW only.
bool

hasColorTexture () const

Returns whether the FBO contains a Texture at GL_COLOR_ATTACHMENT0.
bool

hasDepthBuffer () const

Returns whether the FBO has a Renderbuffer as a depth attachment.
bool

hasStencilBuffer () const

Returns whether the FBO has a Renderbuffer as a stencil attachment.
const std::string &

getLabel () const

Returns the debugging label associated with the Fbo .
void

setLabel (const std::string &label)

Sets the debugging label associated with the Fbo . Calls glObjectLabel() when available.
Format &

label (const std::string &label)

Sets the debugging label associated with the Fbo . Calls glObjectLabel() when available.

Static Public Member Functions

Texture::Format

getDefaultColorTextureFormat (bool alpha=true)

Returns the default color Texture::Format for this platform.
Texture::Format

getDefaultDepthTextureFormat ()

Returns the default depth Texture::Format for this platform.
GLint

getDefaultColorInternalFormat (bool alpha=true)

Returns the default internalFormat for a color Renderbuffer for this platform.
GLint

getDefaultDepthInternalFormat ()

Returns the default internalFormat for a depth Renderbuffer for this platform.
void

getDepthStencilFormats (GLint depthInternalFormat, GLint *resultInternalFormat, GLenum *resultPixelDataType)

Protected Attributes

GLenum

mDepthBufferInternalFormat
int

mSamples
int

mCoverageSamples
bool

mColorTexture
bool

mDepthTexture
bool

mDepthBuffer
bool

mStencilBuffer
Texture::Format

mColorTextureFormat
Texture::Format

mDepthTextureFormat
std::string

mLabel
std::map< GLenum, RenderbufferRef >

mAttachmentsBuffer
std::map< GLenum, RenderbufferRef >

mAttachmentsMultisampleBuffer
std::map< GLenum, TextureBaseRef >

mAttachmentsTexture

Friends

friend class

Fbo

Namespaces

Classes

Modules

Guides

Reference

Format /

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends