ork::Sampler::Parameters Class Reference

A set of texture sampling parameters. More...

#include <Sampler.h>

Inheritance diagram for ork::Sampler::Parameters:

List of all members.

Public Member Functions
	Parameters ()
	Creates a new set of texture sampling parameters with default values.
virtual	~Parameters ()
	Deletes these texture sampling 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.
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 bool	operator< (const Parameters &v) const
	Less Operator for Sampler::Parameters.

---

Detailed Description

A set of texture sampling parameters.

---

Constructor & Destructor Documentation

ork::Sampler::Parameters::Parameters

(

)

Creates a new set of texture sampling parameters with default values.

Reimplemented in ork::Texture::Parameters.

virtual ork::Sampler::Parameters::~Parameters

(

)

[virtual]

Deletes these texture sampling parameters.

Reimplemented in ork::Texture::Parameters.

---

Member Function Documentation

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

const GLfloat* ork::Sampler::Parameters::borderf

(

)

const

Returns the border color as floats.

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

const GLint* ork::Sampler::Parameters::borderi

(

)

const

Returns the border color as integers.

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

const GLint* ork::Sampler::Parameters::borderIi

(

)

const

Returns the border color as Iintegers.

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

const GLuint* ork::Sampler::Parameters::borderIui

(

)

const

Returns the border color as unsigned integers.

Reimplemented in ork::Texture::Parameters.

unsigned int ork::Sampler::Parameters::borderType

(

)

const

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

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

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::Parameters::compareFunc

(

Function

compareFunc

)

[virtual]

Sets the comparison operator used for depth tests.

Parameters:

compareFunc

the comparison operator.

Reimplemented in ork::Texture::Parameters.

Function ork::Sampler::Parameters::compareFunc

(

)

const

Returns the comparison operator used for depth tests.

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

GLfloat ork::Sampler::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 in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::Parameters::lodMax

(

GLfloat

lodMax

)

[virtual]

Sets the maximum level of detail used in this sampler.

Parameters:

lodMax

the maximum level of detail.

Reimplemented in ork::Texture::Parameters.

GLfloat ork::Sampler::Parameters::lodMax

(

)

const

Returns the maximum level of detail used in this sampler.

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::Parameters::lodMin

(

GLfloat

lodMin

)

[virtual]

Sets the minimum level of detail used in this sampler.

Parameters:

lodMin

the minimum level of detail.

Reimplemented in ork::Texture::Parameters.

GLfloat ork::Sampler::Parameters::lodMin

(

)

const

Returns the minimum level of detail used in this sampler.

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

TextureFilter ork::Sampler::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 in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::Parameters::maxAnisotropyEXT

(

GLfloat

maxAnisotropy

)

[virtual]

Sets the anisotropic maximum value parameter.

Parameters:

maxAnisotropy

the anisotropy maximum value.

Reimplemented in ork::Texture::Parameters.

GLfloat ork::Sampler::Parameters::maxAnisotropyEXT

(

)

const

Returns the anisotropic maximum value parameter.

Reimplemented in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

TextureFilter ork::Sampler::Parameters::min

(

)

const

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

Reimplemented in ork::Texture::Parameters.

virtual bool ork::Sampler::Parameters::operator<

(

const Parameters &

v

)

const [virtual]

Less Operator for Sampler::Parameters.

Mostly here to determine if the operators are not the same.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

TextureWrap ork::Sampler::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 in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

TextureWrap ork::Sampler::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 in ork::Texture::Parameters.

virtual Parameters& ork::Sampler::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 in ork::Texture::Parameters.

TextureWrap ork::Sampler::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 in ork::Texture::Parameters.