CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

csBumpMap Class Reference

A class representing a bumpmap. More...

#include <bumpmap.h>

List of all members.

Public Methods

 csBumpMap (iImage *src, int fmt)
 create a new bumpmap in the specified format from the image provided. More...

 ~csBumpMap ()
 deletes a bumpmap. More...

int GetWidth () const
 get width. More...

int GetHeight () const
 get height. More...

void * GetBumpData () const
 get bumpmap data. More...


Protected Attributes

int width
 Width of bumpmap. More...

int height
 Height of bumpmap. More...

uint8 * bumpmap
 The bumpmap data. More...

int format
 BumpMap format (see CS_BUMPFMT_XXX above). More...


Detailed Description

A class representing a bumpmap.

It can be constructed from regular images.

Definition at line 47 of file bumpmap.h.


Constructor & Destructor Documentation

csBumpMap::csBumpMap (  iImage *    src,
int    fmt
) 
 

create a new bumpmap in the specified format from the image provided.

csBumpMap::~csBumpMap (    ) 
 

deletes a bumpmap.


Member Function Documentation

void* csBumpMap::GetBumpData (    )  const [inline]
 

get bumpmap data.

Definition at line 75 of file bumpmap.h.

References bumpmap.

int csBumpMap::GetHeight (    )  const [inline]
 

get height.

Definition at line 73 of file bumpmap.h.

References height.

int csBumpMap::GetWidth (    )  const [inline]
 

get width.

Definition at line 71 of file bumpmap.h.

References width.


Member Data Documentation

uint8* csBumpMap::bumpmap [protected]
 

The bumpmap data.

Definition at line 55 of file bumpmap.h.

Referenced by GetBumpData.

int csBumpMap::format [protected]
 

BumpMap format (see CS_BUMPFMT_XXX above).

Definition at line 57 of file bumpmap.h.

int csBumpMap::height [protected]
 

Height of bumpmap.

Definition at line 53 of file bumpmap.h.

Referenced by GetHeight.

int csBumpMap::width [protected]
 

Width of bumpmap.

Definition at line 51 of file bumpmap.h.

Referenced by GetWidth.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14