vl::Viewport Class Reference

Implements the viewport and clearing settings associated to a Camera. More...

#include <Viewport.hpp>

Inheritance diagram for vl::Viewport:

List of all members.

Public Member Functions
virtual const char *	className ()
	Returns the name of the class.
	Viewport ()
	Viewport (int x, int y, int w, int h)
void	activate () const
bool	null ()
void	set (int x, int y, int w, int h)
void	setX (int x)
int	x () const
void	setY (int y)
int	y () const
void	setWidth (int width)
int	width () const
void	setHeight (int height)
int	height () const
fvec2	center () const
RectI	rect () const
	Returns the rectangular area that defines the viewport computed as RectI(x(), y(), x()+width()-1, y()+height()-1).
void	setClearColor (float r, float g, float b, float a)
void	setClearColor (const fvec4 &color)
const fvec4 &	clearColor () const
void	setClearColorInt (int r, int g, int b, int a)
void	setClearColorInt (const ivec4 &color)
const ivec4 &	clearColorInt () const
void	setClearColorUInt (unsigned int r, unsigned int g, unsigned int b, unsigned int a)
void	setClearColorUInt (const uvec4 &color)
const uvec4 &	clearColorUInt () const
void	setClearStencil (int stencil)
int	clearStencil () const
void	setClearDepth (Real depth)
Real	clearDepth () const
void	setClearFlags (EClearFlags clear_flags)
EClearFlags	clearFlags () const
void	setClearColorMode (EClearColorMode mode)
EClearColorMode	clearColorMode () const
bool	isPointInside (int x, int y, int render_target_height) const
	Returns true if the given point is inside the Viewport.
Protected Attributes
fvec4	mClearColor
ivec4	mClearColorInt
uvec4	mClearColorUInt
Real	mClearDepth
int	mClearStencil
EClearFlags	mClearFlags
EClearColorMode	mClearColorMode
int	mX
int	mY
int	mWidth
int	mHeight

---

Detailed Description

Implements the viewport and clearing settings associated to a Camera.

Supports glClearColor, glClearColorIiEXT and glClearColorIuiEXT (see GL_EXT_texture_integer).

See also:

Camera, Rendering, Renderer

---

Constructor & Destructor Documentation

Viewport::Viewport

(

)

Viewport::Viewport	(	int	x,
		int	y,
		int	w,
		int	h
	)

---

Member Function Documentation

virtual const char* vl::Viewport::className

(

)

[inline, virtual]

Returns the name of the class.

Reimplemented from vl::Object.

void Viewport::activate

(

)

const

bool vl::Viewport::null

(

)

[inline]

void vl::Viewport::set	(	int	x,
		int	y,
		int	w,
		int	h
	)		[inline]

void vl::Viewport::setX

(

int

x )

[inline]

int vl::Viewport::x

(

)

const [inline]

void vl::Viewport::setY

(

int

y )

[inline]

int vl::Viewport::y

(

)

const [inline]

void vl::Viewport::setWidth

(

int

width )

[inline]

int vl::Viewport::width

(

)

const [inline]

void vl::Viewport::setHeight

(

int

height )

[inline]

int vl::Viewport::height

(

)

const [inline]

fvec2 vl::Viewport::center

(

)

const [inline]

RectI vl::Viewport::rect

(

)

const [inline]

Returns the rectangular area that defines the viewport computed as RectI(x(), y(), x()+width()-1, y()+height()-1).

void vl::Viewport::setClearColor	(	float	r,
		float	g,
		float	b,
		float	a
	)		[inline]

void vl::Viewport::setClearColor

(

const fvec4 &

color )

[inline]

const fvec4& vl::Viewport::clearColor

(

)

const [inline]

void vl::Viewport::setClearColorInt	(	int	r,
		int	g,
		int	b,
		int	a
	)		[inline]

void vl::Viewport::setClearColorInt

(

const ivec4 &

color )

[inline]

const ivec4& vl::Viewport::clearColorInt

(

)

const [inline]

void vl::Viewport::setClearColorUInt	(	unsigned int	r,
		unsigned int	g,
		unsigned int	b,
		unsigned int	a
	)		[inline]

void vl::Viewport::setClearColorUInt

(

const uvec4 &

color )

[inline]

const uvec4& vl::Viewport::clearColorUInt

(

)

const [inline]

void vl::Viewport::setClearStencil

(

int

stencil )

[inline]

int vl::Viewport::clearStencil

(

)

const [inline]

void vl::Viewport::setClearDepth

(

Real

depth )

[inline]

Real vl::Viewport::clearDepth

(

)

const [inline]

void vl::Viewport::setClearFlags

(

EClearFlags

clear_flags )

[inline]

EClearFlags vl::Viewport::clearFlags

(

)

const [inline]

void vl::Viewport::setClearColorMode

(

EClearColorMode

mode )

[inline]

EClearColorMode vl::Viewport::clearColorMode

(

)

const [inline]

bool Viewport::isPointInside	(	int	x,
		int	y,
		int	render_target_height
	)		const

Returns true if the given point is inside the Viewport.

---

Member Data Documentation

fvec4 vl::Viewport::mClearColor [protected]

ivec4 vl::Viewport::mClearColorInt [protected]

uvec4 vl::Viewport::mClearColorUInt [protected]

Real vl::Viewport::mClearDepth [protected]

int vl::Viewport::mClearStencil [protected]

EClearFlags vl::Viewport::mClearFlags [protected]

EClearColorMode vl::Viewport::mClearColorMode [protected]

int vl::Viewport::mX [protected]

int vl::Viewport::mY [protected]

int vl::Viewport::mWidth [protected]

int vl::Viewport::mHeight [protected]

---

The documentation for this class was generated from the following files:

• C:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vl/Viewport.hpp
• C:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vl/Viewport.cpp