ork::Texture::Parameters Class Reference

A set of texture parameters. More...

#include <Texture.h>

Inheritance diagram for ork::Texture::Parameters:

List of all members.

Public Member Functions
	Parameters ()
	Creates a new set of texture parameters with default values.
virtual	~Parameters ()
	Deletes this set of texture parameters.
TextureWrap	wrapS () const
	Returns the wrap parameter for texture coordinate s.
TextureWrap	wrapT () const
	Returns the wrap parameter for texture coordinate t.
TextureWrap	wrapR () const
	Returns the wrap parameter for texture coordinate r (only for 3D textures or arrays).
TextureFilter	min () const
	Returns the minifying function used whenever the pixel being textured maps to an area greated than one texture element.
TextureFilter	mag () const
	Returns the magnifying function used whenever the pixel being textured maps to an area less than or equal to one texture element.
unsigned int	borderType () const
	Returns the type of data used to set the border color.
const GLint *	borderi () const
	Returns the border color as integers.
const GLfloat *	borderf () const
	Returns the border color as floats.
const GLint *	borderIi () const
	Returns the border color as Iintegers.
const GLuint *	borderIui () const
	Returns the border color as unsigned integers.
GLfloat	lodMin () const
	Returns the minimum level of detail used in this sampler.
GLfloat	lodMax () const
	Returns the maximum level of detail used in this sampler.
GLfloat	lodBias () const
	Returns the bias applied to the level of details.
Function	compareFunc () const
	Returns the comparison operator used for depth tests.
GLfloat	maxAnisotropyEXT () const
	Returns the anisotropic maximum value parameter.
const char *	swizzle () const
	Returns the current texture swizzling order.
GLint	minLevel () const
	Returns the index of the lowest defined mipmap level.
GLint	maxLevel () const
	Returns the index of the highest defined mipmap level.
virtual Parameters &	wrapS (TextureWrap wrapS)
	Sets the wrap parameter for texture coordinate s.
virtual Parameters &	wrapT (TextureWrap wrapT)
	Sets the wrap parameter for texture coordinate t.
virtual Parameters &	wrapR (TextureWrap wrapR)
	Sets the wrap parameter for texture coordinate r.
virtual Parameters &	min (TextureFilter min)
	Sets the minifying function used whenever the pixel being textured maps to an area greater than one texture element.
virtual Parameters &	mag (TextureFilter mag)
	Sets the magnifying function used whenever the pixel being textured maps to an area less than or equal to one texture element.
virtual Parameters &	borderi (GLint r=0, GLint g=0, GLint b=0, GLint a=0)
	Sets the border color as integers.
virtual Parameters &	borderf (GLfloat r=0.0f, GLfloat g=0.0f, GLfloat b=0.0f, GLfloat a=0.0f)
	Sets the border color as floats.
virtual Parameters &	borderIi (GLint r=0, GLint g=0, GLint b=0, GLint a=0)
	Sets the border color as Lintegers.
virtual Parameters &	borderIui (GLuint r=0, GLuint g=0, GLuint b=0, GLuint a=0)
	Sets the border color as unsigned integers.
virtual Parameters &	lodMin (GLfloat lodMin)
	Sets the minimum level of detail used in this sampler.
virtual Parameters &	lodMax (GLfloat lodMax)
	Sets the maximum level of detail used in this sampler.
virtual Parameters &	lodBias (GLfloat lodBias)
	Sets the bias applied to the level of details.
virtual Parameters &	compareFunc (Function compareFunc)
	Sets the comparison operator used for depth tests.
virtual Parameters &	maxAnisotropyEXT (GLfloat maxAnisotropy)
	Sets the anisotropic maximum value parameter.
virtual Parameters &	swizzle (char r, char g, char b, char a)
	Sets the swizzling order for this Texture.
virtual Parameters &	minLevel (GLint minLevel)
	Sets the index of the lowest defined mipmap level.
virtual Parameters &	maxLevel (GLint maxLevel)
	Sets the index of the highest defined mipmap level.

---

Detailed Description

A set of texture parameters.

---

Constructor & Destructor Documentation

ork::Texture::Parameters::Parameters

(

)

Creates a new set of texture parameters with default values.

Reimplemented from ork::Sampler::Parameters.

virtual ork::Texture::Parameters::~Parameters

(

)

[virtual]

Deletes this set of texture parameters.

Reimplemented from ork::Sampler::Parameters.

---

Member Function Documentation

virtual Parameters& ork::Texture::Parameters::borderf	(	GLfloat	r = 0.0f,
		GLfloat	g = 0.0f,
		GLfloat	b = 0.0f,
		GLfloat	a = 0.0f
	)			[virtual]

Sets the border color as floats.

Parameters:

	r	red component.
	g	green component.
	b	blue component.
	a	alpha component.

Reimplemented from ork::Sampler::Parameters.

const GLfloat* ork::Texture::Parameters::borderf

(

)

const

Returns the border color as floats.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::borderi	(	GLint	r = 0,
		GLint	g = 0,
		GLint	b = 0,
		GLint	a = 0
	)			[virtual]

Sets the border color as integers.

Parameters:

	r	red component.
	g	green component.
	b	blue component.
	a	alpha component.

Reimplemented from ork::Sampler::Parameters.

const GLint* ork::Texture::Parameters::borderi

(

)

const

Returns the border color as integers.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::borderIi	(	GLint	r = 0,
		GLint	g = 0,
		GLint	b = 0,
		GLint	a = 0
	)			[virtual]

Sets the border color as Lintegers.

Parameters:

	r	red component.
	g	green component.
	b	blue component.
	a	alpha component.

Reimplemented from ork::Sampler::Parameters.

const GLint* ork::Texture::Parameters::borderIi

(

)

const

Returns the border color as Iintegers.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::borderIui	(	GLuint	r = 0,
		GLuint	g = 0,
		GLuint	b = 0,
		GLuint	a = 0
	)			[virtual]

Sets the border color as unsigned integers.

Parameters:

	r	red component.
	g	green component.
	b	blue component.
	a	alpha component.

Reimplemented from ork::Sampler::Parameters.

const GLuint* ork::Texture::Parameters::borderIui

(

)

const

Returns the border color as unsigned integers.

Reimplemented from ork::Sampler::Parameters.

unsigned int ork::Texture::Parameters::borderType

(

)

const

Returns the type of data used to set the border color.

Can be int, float, Iint, or unsigned int.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::compareFunc

(

Function

compareFunc

)

[virtual]

Sets the comparison operator used for depth tests.

Parameters:

compareFunc

the comparison operator.

Reimplemented from ork::Sampler::Parameters.

Function ork::Texture::Parameters::compareFunc

(

)

const

Returns the comparison operator used for depth tests.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::lodBias

(

GLfloat

lodBias

)

[virtual]

Sets the bias applied to the level of details.

The bias is the starting value when looking inside a texture, and will be added to the computed level displayed.

Parameters:

lodBias

the bias applied to every lod access.

Reimplemented from ork::Sampler::Parameters.

GLfloat ork::Texture::Parameters::lodBias

(

)

const

Returns the bias applied to the level of details.

The bias is the starting value when looking inside a texture, and will be added to the computed level displayed.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::lodMax

(

GLfloat

lodMax

)

[virtual]

Sets the maximum level of detail used in this sampler.

Parameters:

lodMax

the maximum level of detail.

Reimplemented from ork::Sampler::Parameters.

GLfloat ork::Texture::Parameters::lodMax

(

)

const

Returns the maximum level of detail used in this sampler.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::lodMin

(

GLfloat

lodMin

)

[virtual]

Sets the minimum level of detail used in this sampler.

Parameters:

lodMin

the minimum level of detail.

Reimplemented from ork::Sampler::Parameters.

GLfloat ork::Texture::Parameters::lodMin

(

)

const

Returns the minimum level of detail used in this sampler.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::mag

(

TextureFilter

mag

)

[virtual]

Sets the magnifying function used whenever the pixel being textured maps to an area less than or equal to one texture element.

Parameters:

mag

the magnifying function.

Reimplemented from ork::Sampler::Parameters.

TextureFilter ork::Texture::Parameters::mag

(

)

const

Returns the magnifying function used whenever the pixel being textured maps to an area less than or equal to one texture element.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::maxAnisotropyEXT

(

GLfloat

maxAnisotropy

)

[virtual]

Sets the anisotropic maximum value parameter.

Parameters:

maxAnisotropy

the anisotropy maximum value.

Reimplemented from ork::Sampler::Parameters.

GLfloat ork::Texture::Parameters::maxAnisotropyEXT

(

)

const

Returns the anisotropic maximum value parameter.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::maxLevel

(

GLint

maxLevel

)

[virtual]

Sets the index of the highest defined mipmap level.

GLint ork::Texture::Parameters::maxLevel

(

)

const

Returns the index of the highest defined mipmap level.

virtual Parameters& ork::Texture::Parameters::min

(

TextureFilter

min

)

[virtual]

Sets the minifying function used whenever the pixel being textured maps to an area greater than one texture element.

Parameters:

min

the minifying function.

Reimplemented from ork::Sampler::Parameters.

TextureFilter ork::Texture::Parameters::min

(

)

const

Returns the minifying function used whenever the pixel being textured maps to an area greated than one texture element.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::minLevel

(

GLint

minLevel

)

[virtual]

Sets the index of the lowest defined mipmap level.

GLint ork::Texture::Parameters::minLevel

(

)

const

Returns the index of the lowest defined mipmap level.

virtual Parameters& ork::Texture::Parameters::swizzle	(	char	r,
		char	g,
		char	b,
		char	a
	)			[virtual]

Sets the swizzling order for this Texture.

Enables the user to reorder the components of a texture before it is sent to the GPU. Each parameter can be either 'r', 'g', 'b', or 'a'.

Parameters:

	r	new component for red channel.
	g	new component for green channel.
	b	new component for blue channel.
	a	new component for alpha channel.

const char* ork::Texture::Parameters::swizzle

(

)

const

Returns the current texture swizzling order.

virtual Parameters& ork::Texture::Parameters::wrapR

(

TextureWrap

wrapR

)

[virtual]

Sets the wrap parameter for texture coordinate r.

Determines the behavior of the sampler when sampling out of the borders of the texture.

Parameters:

wrapR

the wrap parameter for coordinate r.

Reimplemented from ork::Sampler::Parameters.

TextureWrap ork::Texture::Parameters::wrapR

(

)

const

Returns the wrap parameter for texture coordinate r (only for 3D textures or arrays).

Determines the behavior of the sampler when sampling out of the borders of the texture.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::wrapS

(

TextureWrap

wrapS

)

[virtual]

Sets the wrap parameter for texture coordinate s.

Determines the behavior of the sampler when sampling out of the borders of the texture.

Parameters:

wrapS

the wrap parameter for coordinate s.

Reimplemented from ork::Sampler::Parameters.

TextureWrap ork::Texture::Parameters::wrapS

(

)

const

Returns the wrap parameter for texture coordinate s.

Determines the behavior of the sampler when sampling out of the borders of the texture.

Reimplemented from ork::Sampler::Parameters.

virtual Parameters& ork::Texture::Parameters::wrapT

(

TextureWrap

wrapT

)

[virtual]

Sets the wrap parameter for texture coordinate t.

Determines the behavior of the sampler when sampling out of the borders of the texture.

Parameters:

wrapT

the wrap parameter for coordinate t.

Reimplemented from ork::Sampler::Parameters.

TextureWrap ork::Texture::Parameters::wrapT

(

)

const

Returns the wrap parameter for texture coordinate t.

Determines the behavior of the sampler when sampling out of the borders of the texture.

Reimplemented from ork::Sampler::Parameters.