ork::Texture3D Class Reference
[render]

A 3D texture. More...

#include <Texture3D.h>

Inheritance diagram for ork::Texture3D:
ork::Texture ork::Object

List of all members.

Public Member Functions

 Texture3D (int w, int h, int d, TextureInternalFormat tf, TextureFormat f, PixelType t, const Parameters &params, const Buffer::Parameters &s, const Buffer &pixels)
 Creates a new 3D texture.
virtual ~Texture3D ()
 Destroys this 3D texture.
int getWidth ()
 Returns the width of this texture.
int getHeight ()
 Returns the height of this texture.
int getDepth ()
 Returns the depth of this texture.
void setSubImage (int level, int x, int y, int z, int w, int h, int d, TextureFormat f, PixelType t, const Buffer::Parameters &s, const Buffer &pixels)
 Replaces a part of the content of this texture.
void setCompressedSubImage (int level, int x, int y, int z, int w, int h, int d, int s, const Buffer &pixels)
 Replaces a part of the content of this texture.

Protected Member Functions

 Texture3D ()
 Creates a new unitialized 3D texture.
void init (int w, int h, int d, TextureInternalFormat tf, TextureFormat f, PixelType t, const Parameters &params, const Buffer::Parameters &s, const Buffer &pixels)
 Initializes this texture.

Protected Attributes

int w
 The width of this texture.
int h
 The height of this texture.
int d
 The depth of this texture.

Detailed Description

A 3D texture.


Constructor & Destructor Documentation

ork::Texture3D::Texture3D ( int  w,
int  h,
int  d,
TextureInternalFormat  tf,
TextureFormat  f,
PixelType  t,
const Parameters params,
const Buffer::Parameters s,
const Buffer pixels 
)

Creates a new 3D texture.

Parameters:
w the width of this texture in pixels.
h the height of this texture in pixels.
d the depth of this texture in pixels.
tf texture data format on GPU.
f the texture components in 'pixels'.
t the type of each component in 'pixels'.
params optional additional texture parameters.
s optional pixel storage parameters for 'pixels'.
pixels the pixels to be written into this texture.
virtual ork::Texture3D::~Texture3D (  )  [virtual]

Destroys this 3D texture.

ork::Texture3D::Texture3D (  )  [protected]

Creates a new unitialized 3D texture.


Member Function Documentation

int ork::Texture3D::getDepth (  ) 

Returns the depth of this texture.

int ork::Texture3D::getHeight (  ) 

Returns the height of this texture.

int ork::Texture3D::getWidth (  ) 

Returns the width of this texture.

void ork::Texture3D::init ( int  w,
int  h,
int  d,
TextureInternalFormat  tf,
TextureFormat  f,
PixelType  t,
const Parameters params,
const Buffer::Parameters s,
const Buffer pixels 
) [protected]

Initializes this texture.

Parameters:
w the width of this texture in pixels.
h the height of this texture in pixels.
d the depth of this texture in pixels.
tf texture data format on GPU.
f the texture components in 'pixels'.
t the type of each component in 'pixels'.
params optional additional texture parameters.
s optional pixel storage parameters for 'pixels'.
pixels the pixels to be written into this texture.
void ork::Texture3D::setCompressedSubImage ( int  level,
int  x,
int  y,
int  z,
int  w,
int  h,
int  d,
int  s,
const Buffer pixels 
)

Replaces a part of the content of this texture.

Parameters:
level the LOD level to be changed.
x lower left corner of the part to be replaced, in pixels.
y lower left corner of the part to be replaced, in pixels.
z lower left corner of the part to be replaced, in pixels.
w the width of the part to be replaced, in pixels.
h the height of the part to be replaced, in pixels.
d the depth of the part to be replaced, in pixels.
s the size of 'pixels' in bytes.
pixels the pixels to be written into this texture LOD level.
void ork::Texture3D::setSubImage ( int  level,
int  x,
int  y,
int  z,
int  w,
int  h,
int  d,
TextureFormat  f,
PixelType  t,
const Buffer::Parameters s,
const Buffer pixels 
)

Replaces a part of the content of this texture.

Parameters:
level the LOD level to be changed.
x lower left corner of the part to be replaced, in pixels.
y lower left corner of the part to be replaced, in pixels.
z lower left corner of the part to be replaced, in pixels.
w the width of the part to be replaced, in pixels.
h the height of the part to be replaced, in pixels.
d the depth of the part to be replaced, in pixels.
f the texture components in 'pixels'.
t the type of each component in 'pixels'.
s optional pixel storage parameters for 'pixels'.
pixels the pixels to be written into this texture LOD level.

Member Data Documentation

int ork::Texture3D::d [protected]

The depth of this texture.

int ork::Texture3D::h [protected]

The height of this texture.

int ork::Texture3D::w [protected]

The width of this texture.


Generated on Mon Oct 18 09:36:10 2010 for ork by  doxygen 1.6.1