BALL::VIEW::FrameBufferFormat Class Reference

This is used by the RenderTarget to specify in which formats it can provide buffers. More...

#include <renderTarget.h>

List of all members.

Public Member Functions
	FrameBufferFormat ()
	Constructs empty invalid framebuffer format.
	FrameBufferFormat (const unsigned int width, const unsigned int height, const PixelFormat &pixelFormat)
	FrameBufferFormat (const unsigned int width, const unsigned int height, const unsigned int pitch, const PixelFormat &pixelFormat)
	FrameBufferFormat (const FrameBufferFormat &format)
const FrameBufferFormat &	operator= (const FrameBufferFormat &format)
bool	operator== (const FrameBufferFormat &format) const
bool	operator!= (const FrameBufferFormat &format) const
bool	isValid () const
unsigned int	getWidth () const
	Returns width of writeable area of buffers in this format, in pixels.
void	setWidth (unsigned int width)
	Sets width of writeable area of buffers in this format, in pixels.
unsigned int	getHeight () const
	Returns height of buffers in this format, in pixels.
void	setHeight (unsigned int height)
	Sets height of buffers in this format, in pixels.
unsigned int	getPitch () const
	Returns actual line width of buffers in this format, in bytes.
void	setPitch (unsigned int pitch)
	Sets actual line width of buffers in this format, in bytes.
const PixelFormat &	getPixelFormat () const
	Returns pixel format of buffers in this format.
void	setPixelFormat (const PixelFormat &pixelFormat)
	Sets pixel format of buffers in this format.
size_t	computeSize () const
	Computes size of the framebuffer with this format: size = pitch * height.
void	resize (const unsigned int newWidth, const unsigned int newHeight)
	Modify width and height of this format.
const FrameBufferFormat	resized (const unsigned int newWidth, const unsigned int newHeight) const
	Returns new FrameBufferFormat where width and height are replaced by specified values.

---

Detailed Description

This is used by the RenderTarget to specify in which formats it can provide buffers.

---

Member Function Documentation

unsigned int BALL::VIEW::FrameBufferFormat::getHeight

(

)

const

Returns height of buffers in this format, in pixels.

Referenced by computeSize().

void BALL::VIEW::FrameBufferFormat::setHeight

(

unsigned int

height

)

Sets height of buffers in this format, in pixels.