Texture Library


Data Structures

struct  pgeTexture

Enumerations

enum  pgePixelFormat {
  PGE_PIXEL_FORMAT_5650,
  PGE_PIXEL_FORMAT_5551,
  PGE_PIXEL_FORMAT_4444,
  PGE_PIXEL_FORMAT_8888,
  PGE_PIXEL_FORMAT_T4,
  PGE_PIXEL_FORMAT_T8,
  PGE_PIXEL_FORMAT_T16,
  PGE_PIXEL_FORMAT_T32
}
enum  pgeTextureMode {
  PGE_TEX_MODE_MODULATE,
  PGE_TEX_MODE_DECAL,
  PGE_TEX_MODE_BLEND,
  PGE_TEX_MODE_REPLACE,
  PGE_TEX_MODE_ADD
}
enum  pgeMemoryLocation {
  PGE_RAM,
  PGE_VRAM
}

Functions

pgeTexturepgeTextureLoad (const char *filename, enum pgeMemoryLocation location, unsigned char swizzle)
pgeTexturepgeTextureLoadMemory (unsigned char *buffer, int size, enum pgeMemoryLocation location, unsigned char swizzle)
void pgeTextureDestroy (pgeTexture *texture)
pgeTexturepgeTextureCreate (unsigned int width, unsigned int height, enum pgePixelFormat format, enum pgeMemoryLocation location)
int pgeTextureSwizzle (pgeTexture *texture)
int pgeTextureUnswizzle (pgeTexture *texture)
unsigned int pgeTextureGetPixel (pgeTexture *texture, unsigned int x, unsigned int y)
void pgeTextureSetPixel (pgeTexture *texture, unsigned int color, unsigned int x, unsigned int y)
void pgeTextureActivate (pgeTexture *texture)
int pgeTextureToRam (pgeTexture *texture)
int pgeTextureToVram (pgeTexture *texture)
int pgeTextureModeSet (enum pgeTextureMode mode)
void pgeTextureSave (pgeTexture *texture, const char *filename)
void pgeTextureScreenshot (const char *filename)

Enumeration Type Documentation

Enumerator:
PGE_RAM 
PGE_VRAM 

Enumerator:
PGE_PIXEL_FORMAT_5650  Pixelformat R5:G6:B5:A0.
PGE_PIXEL_FORMAT_5551  Pixelformat R5:G5:B5:A1.
PGE_PIXEL_FORMAT_4444  Pixelformat R4:G4:B4:A4.
PGE_PIXEL_FORMAT_8888  Pixelformat R8:G8:B8:A8.
PGE_PIXEL_FORMAT_T4  Pixelformat 4bit indexed.
PGE_PIXEL_FORMAT_T8  Pixelformat 8bit indexed.
PGE_PIXEL_FORMAT_T16  Pixelformat 16bit indexed.
PGE_PIXEL_FORMAT_T32  Pixelformat 32bit indexed.

Enumerator:
PGE_TEX_MODE_MODULATE 
PGE_TEX_MODE_DECAL 
PGE_TEX_MODE_BLEND 
PGE_TEX_MODE_REPLACE 
PGE_TEX_MODE_ADD 


Function Documentation

void pgeTextureActivate ( pgeTexture texture  ) 

Activate a texture, ready for drawing

Parameters:
texture - A valid pgeTexture

pgeTexture* pgeTextureCreate ( unsigned int  width,
unsigned int  height,
enum pgePixelFormat  format,
enum pgeMemoryLocation  location 
)

Create a texture

Parameters:
width - Width of the texture
height - Height of the texture
format - One of pgePixelFormat
location - One of pgeMemoryLocation
Returns:
A pointer to a pgeTexture struct or NULL on error.

void pgeTextureDestroy ( pgeTexture texture  ) 

Destroy a previously created texture

Parameters:
texture - A valid pgeTexture

unsigned int pgeTextureGetPixel ( pgeTexture texture,
unsigned int  x,
unsigned int  y 
)

Get a color value from a texture

Parameters:
texture - A valid pgeTexture
x - X position
y - Y position

pgeTexture* pgeTextureLoad ( const char *  filename,
enum pgeMemoryLocation  location,
unsigned char  swizzle 
)

Load a texture (PNG)

Parameters:
filename - Path of the file to load.
location - One of pgeMemoryLocation
swizzle - Set to 1 to swizzle, 0 to not
Returns:
A pointer to a pgeTexture struct or NULL on error.

pgeTexture* pgeTextureLoadMemory ( unsigned char *  buffer,
int  size,
enum pgeMemoryLocation  location,
unsigned char  swizzle 
)

Load a PNG texture from memory

Parameters:
buffer - A pointer to the image data
size - Size of the image data
location - One of pgeMemoryLocation
swizzle - Set to 1 to swizzle, 0 to not
Returns:
A pointer to a pgeTexture struct or NULL on error.

int pgeTextureModeSet ( enum pgeTextureMode  mode  ) 

Set the texture mode

Parameters:
mode - One of pgeTextureMode
Returns:
The previous mode.

void pgeTextureSave ( pgeTexture texture,
const char *  filename 
)

Save a texture to a PNG file

Parameters:
texture - Texture to convert to PNG
filename - File path of the PNG

void pgeTextureScreenshot ( const char *  filename  ) 

Take a screenshot.

Parameters:
filename - File name to save the screenshot as.

void pgeTextureSetPixel ( pgeTexture texture,
unsigned int  color,
unsigned int  x,
unsigned int  y 
)

Set a color value in a texture

Parameters:
texture - A valid pgeTexture
color - The color value to set
x - X position
y - Y position

int pgeTextureSwizzle ( pgeTexture texture  ) 

Swizzle a texture

Parameters:
texture - A valid pgeTexture

int pgeTextureToRam ( pgeTexture texture  ) 

Move a texture from VRAM to RAM

Parameters:
texture - A valid pgeTexture

int pgeTextureToVram ( pgeTexture texture  ) 

Move a texture from RAM to VRAM

Parameters:
texture - A valid pgeTexture

int pgeTextureUnswizzle ( pgeTexture texture  ) 

Unswizzle a texture

Parameters:
texture - A valid pgeTexture


Generated on Mon Sep 22 16:58:14 2008 for Phoenix Game Engine by  doxygen 1.5.5