BALL  1.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
BALL::VIEW::FrameBufferFormat Class Reference

#include <BALL/VIEW/RENDERING/renderTarget.h>

Public Member Functions

 FrameBufferFormat ()
 
 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 FrameBufferFormatoperator= (const FrameBufferFormat &format)
 
bool operator== (const FrameBufferFormat &format) const
 
bool operator!= (const FrameBufferFormat &format) const
 
bool isValid () const
 
unsigned int getWidth () const
 
void setWidth (unsigned int width)
 
unsigned int getHeight () const
 
void setHeight (unsigned int height)
 
unsigned int getPitch () const
 
void setPitch (unsigned int pitch)
 
const PixelFormatgetPixelFormat () const
 
void setPixelFormat (const PixelFormat &pixelFormat)
 
size_t computeSize () const
 
void resize (const unsigned int newWidth, const unsigned int newHeight)
 
const FrameBufferFormat resized (const unsigned int newWidth, const unsigned int newHeight) const
 

Private Attributes

unsigned int width
 
unsigned int height
 
unsigned int pitch
 
PixelFormat pixelFormat
 

Detailed Description

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

Definition at line 38 of file renderTarget.h.

Constructor & Destructor Documentation

BALL::VIEW::FrameBufferFormat::FrameBufferFormat ( )
inline

Constructs empty invalid framebuffer format

Definition at line 43 of file renderTarget.h.

BALL::VIEW::FrameBufferFormat::FrameBufferFormat ( const unsigned int  width,
const unsigned int  height,
const PixelFormat pixelFormat 
)
inline

Definition at line 47 of file renderTarget.h.

BALL::VIEW::FrameBufferFormat::FrameBufferFormat ( const unsigned int  width,
const unsigned int  height,
const unsigned int  pitch,
const PixelFormat pixelFormat 
)
inline

Definition at line 56 of file renderTarget.h.

BALL::VIEW::FrameBufferFormat::FrameBufferFormat ( const FrameBufferFormat format)
inline

Definition at line 63 of file renderTarget.h.

Member Function Documentation

size_t BALL::VIEW::FrameBufferFormat::computeSize ( ) const
inline

Computes size of the framebuffer with this format: size = pitch * height

Definition at line 124 of file renderTarget.h.

unsigned int BALL::VIEW::FrameBufferFormat::getHeight ( ) const
inline

Returns height of buffers in this format, in pixels.

Definition at line 103 of file renderTarget.h.

unsigned int BALL::VIEW::FrameBufferFormat::getPitch ( ) const
inline

Returns actual line width of buffers in this format, in bytes

Definition at line 109 of file renderTarget.h.

const PixelFormat& BALL::VIEW::FrameBufferFormat::getPixelFormat ( ) const
inline

Returns pixel format of buffers in this format

Definition at line 115 of file renderTarget.h.

unsigned int BALL::VIEW::FrameBufferFormat::getWidth ( ) const
inline

Returns width of writeable area of buffers in this format, in pixels.

Definition at line 95 of file renderTarget.h.

bool BALL::VIEW::FrameBufferFormat::isValid ( ) const
inline

Definition at line 90 of file renderTarget.h.

bool BALL::VIEW::FrameBufferFormat::operator!= ( const FrameBufferFormat format) const
inline

Definition at line 84 of file renderTarget.h.

const FrameBufferFormat& BALL::VIEW::FrameBufferFormat::operator= ( const FrameBufferFormat format)
inline

Definition at line 69 of file renderTarget.h.

bool BALL::VIEW::FrameBufferFormat::operator== ( const FrameBufferFormat format) const
inline

Definition at line 78 of file renderTarget.h.

void BALL::VIEW::FrameBufferFormat::resize ( const unsigned int  newWidth,
const unsigned int  newHeight 
)
inline

Modify width and height of this format

Definition at line 131 of file renderTarget.h.

const FrameBufferFormat BALL::VIEW::FrameBufferFormat::resized ( const unsigned int  newWidth,
const unsigned int  newHeight 
) const
inline

Returns new FrameBufferFormat where width and height are replaced by specified values.

Definition at line 140 of file renderTarget.h.

void BALL::VIEW::FrameBufferFormat::setHeight ( unsigned int  height)
inline

Sets height of buffers in this format, in pixels.

Definition at line 106 of file renderTarget.h.

void BALL::VIEW::FrameBufferFormat::setPitch ( unsigned int  pitch)
inline

Sets actual line width of buffers in this format, in bytes

Definition at line 112 of file renderTarget.h.

void BALL::VIEW::FrameBufferFormat::setPixelFormat ( const PixelFormat pixelFormat)
inline

Sets pixel format of buffers in this format

Definition at line 118 of file renderTarget.h.

void BALL::VIEW::FrameBufferFormat::setWidth ( unsigned int  width)
inline

Sets width of writeable area of buffers in this format, in pixels.

Definition at line 100 of file renderTarget.h.

Member Data Documentation

unsigned int BALL::VIEW::FrameBufferFormat::height
private

Height of buffers in this format, in pixels.

Definition at line 151 of file renderTarget.h.

unsigned int BALL::VIEW::FrameBufferFormat::pitch
private

Actual line width of this buffer. You can compute the beginning of a line as firstPixel + pitch * lineNr. Unlike width and height, the pitch is measured in bytes. This may be needed in cases where the pitch is not a multiple of the byte size of a single pixel.

Definition at line 159 of file renderTarget.h.

PixelFormat BALL::VIEW::FrameBufferFormat::pixelFormat
private

Definition at line 161 of file renderTarget.h.

unsigned int BALL::VIEW::FrameBufferFormat::width
private

Width of writeable area of this buffer, in pixels.

Definition at line 148 of file renderTarget.h.