sf::RenderTarget Class Reference

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• Class List
• Class Index
• Class Hierarchy
• Class Members

• sf
• RenderTarget

Public Member Functions | Protected Member Functions | List of all members

sf::RenderTarget Class Reference

Base class for all render targets (window, image, ...). More...

#include <SFML/Graphics/RenderTarget.hpp>

Inheritance diagram for sf::RenderTarget:

Public Member Functions
virtual	~RenderTarget ()
	Destructor.
void	Clear (const Color &FillColor=Color(0, 0, 0))
	Clear the entire target with a single color.
virtual void	Draw (const Drawable &Object)
	Draw something into the target.
virtual unsigned int	GetWidth () const =0
	Get the width of the rendering region of the target.
virtual unsigned int	GetHeight () const =0
	Get the height of the rendering region of the target.
void	SetView (const View &NewView)
	Change the current active view.
const View &	GetView () const
	Get the current view.
View &	GetDefaultView ()
	Get the default view of the window for read / write.
void	PreserveOpenGLStates (bool Preserve)
	Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

Protected Member Functions
	RenderTarget ()
	Default constructor.
void	Initialize ()
	Called by the derived class when it's ready to be initialized.

Detailed Description

Base class for all render targets (window, image, ...).

Definition at line 43 of file RenderTarget.hpp.

Constructor & Destructor Documentation

~RenderTarget()

virtual sf::RenderTarget::~RenderTarget ( )

virtual

Destructor.

RenderTarget()

sf::RenderTarget::RenderTarget ( )

protected

Default constructor.

Member Function Documentation

Clear()

void sf::RenderTarget::Clear

(

const Color &

FillColor = Color(0, 0, 0)

)

Clear the entire target with a single color.

Parameters

FillColor

: Color to use to clear the render target

Draw()

virtual void sf::RenderTarget::Draw ( const Drawable & Object )

virtual

Draw something into the target.

Parameters

Object

: Object to draw

GetDefaultView()

View & sf::RenderTarget::GetDefaultView

(

)

Get the default view of the window for read / write.

Returns

Default view

GetHeight()

virtual unsigned int sf::RenderTarget::GetHeight ( ) const

pure virtual

Get the height of the rendering region of the target.

Returns

Height in pixels

Implemented in sf::RenderWindow.

GetView()

const View & sf::RenderTarget::GetView

(

)

const

Get the current view.

Returns

Current view active in the window

GetWidth()

virtual unsigned int sf::RenderTarget::GetWidth ( ) const

pure virtual

Get the width of the rendering region of the target.

Returns

Width in pixels

Implemented in sf::RenderWindow.

Initialize()

void sf::RenderTarget::Initialize ( )

protected

Called by the derived class when it's ready to be initialized.

PreserveOpenGLStates()

void sf::RenderTarget::PreserveOpenGLStates

(

bool

Preserve

)

Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default

Parameters

Preserve

: True to preserve OpenGL states, false to let SFML optimize

SetView()

void sf::RenderTarget::SetView

(

const View &

NewView

)

Change the current active view.

Parameters

NewView

: New view to use (pass GetDefaultView() to set the default view)

---

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

• RenderTarget.hpp