Texture

Texture mapping. More...

Collaboration diagram for Texture:

Files
file	texture.h
enum	SRPTextureWrappingMode { TW_REPEAT , TW_CLAMP_TO_EDGE }
enum	SRPTextureParameter { SRP_TEXTURE_WRAPPING_MODE_X , SRP_TEXTURE_WRAPPING_MODE_Y }
typedef struct SRPTexture	SRPTexture
typedef enum SRPTextureParameter	SRPTextureParameter
SRPTexture *	srpNewTexture (const char *image, SRPTextureWrappingMode wrappingModeX, SRPTextureWrappingMode wrappingModeY)
void	srpFreeTexture (SRPTexture *this)
void	srpTextureGetFilteredColor (const SRPTexture *this, float u, float v, float out[4])
int	srpTextureGet (SRPTexture *this, SRPTextureParameter parameter)
void	srpTextureSet (SRPTexture *this, SRPTextureParameter parameter, int data)

Detailed Description

Texture mapping.

Typedef Documentation

SRPTexture

typedef struct SRPTexture SRPTexture

A structure to represent a texture

SRPTextureParameter

typedef enum SRPTextureParameter SRPTextureParameter

Holds all possible arguments to SRPTexture getters and setters

See also

srpTextureGet() srpTextureSet()

Enumeration Type Documentation

SRPTextureParameter

enum SRPTextureParameter

Holds all possible arguments to SRPTexture getters and setters

See also

srpTextureGet() srpTextureSet()

SRPTextureWrappingMode

enum SRPTextureWrappingMode

Holds texture wrapping modes

See also

SRPTexture

Enumerator
TW_REPEAT	Repeat the texture when it's wrapped
TW_CLAMP_TO_EDGE	Clamp the texture to the edge when it's wrapped

Function Documentation

srpFreeTexture()

void srpFreeTexture

(

SRPTexture *

this

)

Free a texture

Parameters

[in]

this

A pointer to the texture, as returned by srpNewTexture()

srpNewTexture()

SRPTexture * srpNewTexture	(	const char *	image,
		SRPTextureWrappingMode	wrappingModeX,
		SRPTextureWrappingMode	wrappingModeY
	)

Initialize a texture by loading an image

Parameters

[in]	image	A filesystem path to an image. Most popular image types are supported
[in]	wrappingModeX,wrappingModeY	Wrapping modes to use in X and Y axes

Returns

A pointer to the constructed texture

srpTextureGet()

int srpTextureGet	(	SRPTexture *	this,
		SRPTextureParameter	parameter
	)

Get a parameter from existing SRPTexture

Parameters

[in]	this	A pointer to texture
[in]	parameter	A struct member to get

Returns

Requested member, or -1 on failure

srpTextureGetFilteredColor()

void srpTextureGetFilteredColor	(	const SRPTexture *	this,
		float	u,
		float	v,
		float	out[4]
	)

Get a texel color at u, v by filtering the texture using specified modes

Parameters

[in]	this	A pointer to the texture, as returned by srpNewTexture()
[in]	u,v	Coordinates of the requested texel
[out]	out	An array of 4 values each in [0, 1] interval, representing RGBA8888 color (0.0 = 0x0; 1.0 = 0xFF)

srpTextureSet()

void srpTextureSet	(	SRPTexture *	this,
		SRPTextureParameter	parameter,
		int	data
	)

Set a parameter to existing SRPTexture

Parameters

[in]	this	A pointer to texture
[in]	parameter	A struct member to set to
[in]	data	A value to set