cinder::gl::Renderbuffer Class Reference

Represents an OpenGL Renderbuffer, used primarily in conjunction with FBOs. Supported on OpenGL ES but multisampling is currently ignored. Implicitly shared object. More...

#include <Fbo.h>

List of all members.

Classes
struct	Obj
Public Member Functions
	Renderbuffer ()
	Creates a NULL Renderbuffer.
	Renderbuffer (int width, int height, GLenum internalFormat=GL_RGBA8_OES)
	Create a Renderbuffer width pixels wide and heigh pixels high, with an internal format of internalFormat, defaulting to GL_RGBA8.
	Renderbuffer (int width, int height, GLenum internalFormat=GL_RGBA8)
	Renderbuffer (int width, int height, GLenum internalFormat, int msaaSamples, int coverageSamples=0)
	Create a Renderbuffer width pixels wide and heigh pixels high, with an internal format of internalFormat, defaulting to GL_RGBA8, MSAA samples msaaSamples, and CSAA samples coverageSamples.
int	getWidth () const
	Returns the width of the Renderbuffer in pixels.
int	getHeight () const
	Returns the height of the Renderbuffer in pixels.
Vec2i	getSize () const
	Returns the size of the Renderbuffer in pixels.
Area	getBounds () const
	Returns the bounding area of the Renderbuffer in pixels.
float	getAspectRatio () const
	Returns the aspect ratio of the Renderbuffer.
GLuint	getId () const
	Returns the ID of the Renderbuffer.
GLenum	getInternalFormat () const
	Returns the internal format of the Renderbuffer.
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.
typedef std::shared_ptr< Obj > Renderbuffer::*	unspecified_bool_type
	Emulates shared_ptr-like behavior.
	operator unspecified_bool_type () const
	Emulates shared_ptr-like behavior.
void	reset ()
	Emulates shared_ptr-like behavior.

---

Detailed Description

Represents an OpenGL Renderbuffer, used primarily in conjunction with FBOs. Supported on OpenGL ES but multisampling is currently ignored. Implicitly shared object.

---

Member Typedef Documentation

typedef std::shared_ptr<Obj> Renderbuffer::* cinder::gl::Renderbuffer::unspecified_bool_type

Emulates shared_ptr-like behavior.

---

Constructor & Destructor Documentation

cinder::gl::Renderbuffer::Renderbuffer

(

)

Creates a NULL Renderbuffer.

cinder::gl::Renderbuffer::Renderbuffer	(	int	width,
		int	height,
		GLenum	internalFormat = GL_RGBA8_OES
	)

Create a Renderbuffer width pixels wide and heigh pixels high, with an internal format of internalFormat, defaulting to GL_RGBA8.

cinder::gl::Renderbuffer::Renderbuffer	(	int	width,
		int	height,
		GLenum	internalFormat = GL_RGBA8
	)

cinder::gl::Renderbuffer::Renderbuffer	(	int	width,
		int	height,
		GLenum	internalFormat,
		int	msaaSamples,
		int	coverageSamples = 0
	)

Create a Renderbuffer width pixels wide and heigh pixels high, with an internal format of internalFormat, defaulting to GL_RGBA8, MSAA samples msaaSamples, and CSAA samples coverageSamples.

---

Member Function Documentation

int cinder::gl::Renderbuffer::getWidth

(

)

const

Returns the width of the Renderbuffer in pixels.

int cinder::gl::Renderbuffer::getHeight

(

)

const

Returns the height of the Renderbuffer in pixels.

Vec2i cinder::gl::Renderbuffer::getSize

(

)

const

Returns the size of the Renderbuffer in pixels.

Area cinder::gl::Renderbuffer::getBounds

(

)

const

Returns the bounding area of the Renderbuffer in pixels.

float cinder::gl::Renderbuffer::getAspectRatio

(

)

const

Returns the aspect ratio of the Renderbuffer.

GLuint cinder::gl::Renderbuffer::getId

(

)

const

Returns the ID of the Renderbuffer.

GLenum cinder::gl::Renderbuffer::getInternalFormat

(

)

const

Returns the internal format of the Renderbuffer.

int cinder::gl::Renderbuffer::getSamples

(

)

const

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

int cinder::gl::Renderbuffer::getCoverageSamples

(

)

const

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

cinder::gl::Renderbuffer::operator unspecified_bool_type

(

)

const

Emulates shared_ptr-like behavior.

void cinder::gl::Renderbuffer::reset

(

)

Emulates shared_ptr-like behavior.

---

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

• include/cinder/gl/Fbo.h
• src/cinder/gl/Fbo.cpp