gui::render_target Class Reference

A place to render things (the screen, a texture, ...). More...

#include <gui_rendertarget.hpp>

Inheritance diagram for gui::render_target:

List of all members.

Public Member Functions
	render_target ()
	Constructor.
virtual	~render_target ()
	Destructor.
virtual void	begin ()=0
	Begins rendering on this target.
virtual void	end ()=0
	Ends rendering on this target.
virtual void	clear (const color &mColor)=0
	Clears the content of this render_target.
virtual uint	get_width () const =0
	Returns this render target's width.
virtual uint	get_height () const =0
	Returns this render target's height.
virtual bool	set_dimensions (uint uiWidth, uint uiHeight)=0
	Sets this render target's dimensions.
virtual uint	get_real_width () const =0
	Returns this render target's real width.
virtual uint	get_real_height () const =0
	Returns this render target's real height.

---

Detailed Description

A place to render things (the screen, a texture, ...).

Note:

This is an abstract class that must be inherited from and created by manager_impl.

Definition at line 13 of file gui_rendertarget.hpp.

---

Constructor & Destructor Documentation

gui::render_target::render_target

(

)

Constructor.

Definition at line 5 of file gui_rendertarget.cpp.

gui::render_target::~render_target

(

)

[virtual]

Destructor.

Reimplemented in gui::gl::render_target.

Definition at line 9 of file gui_rendertarget.cpp.

---

Member Function Documentation

virtual void gui::render_target::begin

(

)

[pure virtual]

Begins rendering on this target.

Implemented in gui::gl::render_target.

virtual void gui::render_target::clear

(

const color &

mColor

)

[pure virtual]

Clears the content of this render_target.

Parameters:

mColor

The color to use as background

Implemented in gui::gl::render_target.

virtual void gui::render_target::end

(

)

[pure virtual]

Ends rendering on this target.

Implemented in gui::gl::render_target.

virtual uint gui::render_target::get_height

(

)

const [pure virtual]

Returns this render target's height.

Returns:

This render target's height

Implemented in gui::gl::render_target.

virtual uint gui::render_target::get_real_height

(

)

const [pure virtual]

Returns this render target's real height.

Returns:

This render target's real height

Note:

This is the physical size of the render target. On some systems, abitrary dimensions are not supported : they can be promoted to the nearest power of two from for example.

Implemented in gui::gl::render_target.

virtual uint gui::render_target::get_real_width

(

)

const [pure virtual]

Returns this render target's real width.

Returns:

This render target's real width

Note:

This is the physical size of the render target. On some systems, abitrary dimensions are not supported : they can be promoted to the nearest power of two from for example.

Implemented in gui::gl::render_target.

virtual uint gui::render_target::get_width

(

)

const [pure virtual]

Returns this render target's width.

Returns:

This render target's width

Implemented in gui::gl::render_target.

virtual bool gui::render_target::set_dimensions	(	uint	uiWidth,
		uint	uiHeight
	)			[pure virtual]

Sets this render target's dimensions.

Parameters:

	uiWidth	This render target's width
	uiHeight	This render target's height

Returns:

'true' if the function had to re-create a new render target

Implemented in gui::gl::render_target.

---

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

• D:/Programmation/Sources/lxgui/bak/lxgui/gui/include/gui_rendertarget.hpp
• D:/Programmation/Sources/lxgui/bak/lxgui/gui/src/gui_rendertarget.cpp