The main class of the SDL-based renderer. More...

#include <renderbackendsdl.h>

Inheritance diagram for FIFE::RenderBackendSDL:

Collaboration diagram for FIFE::RenderBackendSDL:

Public Member Functions
	RenderBackendSDL (const SDL_Color &colorkey)

virtual	~RenderBackendSDL ()

virtual const std::string &	getName () const
	The name of the renderbackend. More...

virtual void	startFrame ()
	Called when a new frame starts. More...

virtual void	endFrame ()
	Called when a frame is finished and ready to be displayed. More...

virtual void	init (const std::string &driver)
	Initializes the backend. More...

virtual void	clearBackBuffer ()
	Forces a clear of the backbuffer. More...

virtual void	setLightingModel (uint32_t lighting)
	Initializes the light. More...

virtual uint32_t	getLightingModel () const
	Gets the current light model. More...

virtual void	setLighting (float red, float green, float blue)
	Set colors for lighting. More...

virtual void	resetLighting ()
	Reset lighting with default values. More...

virtual void	resetStencilBuffer (uint8_t buffer)
	Reset stencil buffer with given value. More...

virtual void	changeBlending (int32_t scr, int32_t dst)
	Change the Blendingmodel. More...

virtual void	createMainScreen (const ScreenMode &mode, const std::string &title, const std::string &icon)
	Creates the mainscreen (the display window). More...

virtual void	setScreenMode (const ScreenMode &mode)
	Sets the mainscreen display mode. More...

virtual Image *	createImage (IResourceLoader *loader=0)

virtual Image *	createImage (const std::string &name, IResourceLoader *loader=0)

virtual Image *	createImage (const uint8_t *data, uint32_t width, uint32_t height)
	Creates an Image suitable for this renderbackend. More...

virtual Image *	createImage (const std::string &name, const uint8_t *data, uint32_t width, uint32_t height)

virtual Image *	createImage (SDL_Surface *surface)
	Helper function to create images from SDL_Surfaces. More...

virtual Image *	createImage (const std::string &name, SDL_Surface *surface)

virtual void	renderVertexArrays ()
	Render the Vertex Arrays, only for primitives (points, lines,...) More...

virtual void	addImageToArray (uint32_t id, const Rect &rec, float const st, uint8_t alpha, uint8_t const rgba)
	Add the Image data to the array. More...

virtual void	changeRenderInfos (RenderDataType type, uint16_t elements, int32_t src, int32_t dst, bool light, bool stentest, uint8_t stenref, GLConstants stenop, GLConstants stenfunc, OverlayType otype=OVERLAY_TYPE_NONE)
	Dirty helper function to change the render infos. More...

virtual void	captureScreen (const std::string &filename)
	Creates a Screenshot and saves it to a file. More...

virtual void	captureScreen (const std::string &filename, uint32_t width, uint32_t height)
	Creates a Screenshot with the given size(w,h) and saves it to a file. More...

virtual bool	putPixel (int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
	Writes pixel to given position. More...

virtual void	drawLine (const Point &p1, const Point &p2, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
	Draws line between given points with given RGBA. More...

virtual void	drawTriangle (const Point &p1, const Point &p2, const Point &p3, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
	Draws triangle between given points with given RGBA. More...

virtual void	drawRectangle (const Point &p, uint16_t w, uint16_t h, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
	Draws an axis parallel rectangle. More...

virtual void	fillRectangle (const Point &p, uint16_t w, uint16_t h, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
	Draws a filled axis parallel rectangle. More...

virtual void	drawQuad (const Point &p1, const Point &p2, const Point &p3, const Point &p4, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
	Draws quad between given points with given RGBA. More...

virtual void	drawVertex (const Point &p, const uint8_t size, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)
	Draws a quad that represents a vertex with given RGBA. More...

virtual void	drawLightPrimitive (const Point &p, uint8_t intensity, float radius, int32_t subdivisions, float xstretch, float ystretch, uint8_t red, uint8_t green, uint8_t blue)
	Draws a light primitive that based on a triangle fan. More...

virtual void	enableScissorTest ()
	Enables scissor test on the render backend. More...

virtual void	disableScissorTest ()
	Disables scissor test on the render backend. More...

virtual void	attachRenderTarget (ImagePtr &img, bool discard)
	Attaches given image as a new render surface. More...

virtual void	detachRenderTarget ()
	Detaches current render surface. More...

virtual void	renderGuiGeometry (const std::vector< GuiVertex > &vertices, const std::vector< int > &indices, const DoublePoint &translation, ImagePtr texture)
	Renders geometry required by gui. More...

Public Member Functions inherited from FIFE::RenderBackend
	RenderBackend (const SDL_Color &colorkey)
	Constructor. More...

virtual	~RenderBackend ()
	Destructor. More...

void	deinit ()
	Performs cleanup actions. More...

const ScreenMode &	getCurrentScreenMode () const
	Get current screen mode. More...

uint32_t	getWidth () const

uint32_t	getHeight () const

uint32_t	getScreenWidth () const

uint32_t	getScreenHeight () const

const Rect &	getArea () const

void	pushClipArea (const Rect &cliparea, bool clear=true)
	Pushes clip area to clip stack Clip areas define which area is drawn on screen. More...

void	popClipArea ()
	Pops clip area from clip stack. More...

const Rect &	getClipArea () const
	Gets the current clip area. More...

void	setAlphaOptimizerEnabled (bool enabled)
	Enable or disable the alpha 'optimizing' code. More...

bool	isAlphaOptimizerEnabled () const

void	setImageCompressingEnabled (bool enabled)
	Enables or disable compressing images by video driver. More...

bool	isImageCompressingEnabled () const

void	setFramebufferEnabled (bool enabled)
	Enables or disable the usage of the framebuffer, if available. More...

bool	isFramebufferEnabled () const

void	setNPOTEnabled (bool enabled)
	Enables or disable the usage of npot, if available. More...

bool	isNPOTEnabled () const

void	setTextureFiltering (TextureFiltering filter)
	Sets the texture filtering method. More...

TextureFiltering	getTextureFiltering () const

void	setMipmappingEnabled (bool enabled)
	Enables or disables the usage of mipmapping. More...

bool	isMipmappingEnabled () const

int32_t	getMaxAnisotropy () const
	Gets max antisotropy for antisotropic filtering. More...

void	setMonochromeEnabled (bool enabled)
	Enables or disables monochrome rendering. More...

bool	isMonochromeEnabled () const

void	setDepthBufferEnabled (bool enabled)
	Enables or disables depth buffer rendering. More...

bool	isDepthBufferEnabled () const

void	setAlphaTestValue (float alpha)
	Sets the value for alpha test. More...

float	getAlphaTestValue () const

void	setColorKeyEnabled (bool colorkeyenable)
	Sets whether to use the colorkey feature. More...

bool	isColorKeyEnabled () const
	Gets whether the colorkey feature is in use. More...

void	setColorKey (const SDL_Color &colorkey)
	Sets the global colorkey to use for images. More...

const SDL_Color &	getColorKey () const
	Gets the global colorkey setting. More...

void	setBackgroundColor (uint8_t r, uint8_t g, uint8_t b)
	Set the background color. More...

void	resetBackgroundColor ()
	Reset the background color to black. More...

const SDL_PixelFormat &	getPixelFormat () const
	Gets the current screen rgba format. More...

void	setFrameLimitEnabled (bool limited)
	Sets whether to use the frame limiter. More...

bool	isFrameLimitEnabled () const
	Gets whether the frame limiter is in use. More...

void	setFrameLimit (uint16_t framelimit)
	Sets the frame limit. More...

uint16_t	getFrameLimit () const
	Gets the frame limit. More...

SDL_Surface *	getRenderTargetSurface ()
	Returns currently attached render surface. More...

Public Member Functions inherited from FIFE::DynamicSingleton< RenderBackend >
	DynamicSingleton ()

virtual	~DynamicSingleton ()

Protected Member Functions
virtual void	setClipArea (const Rect &cliparea, bool clear)
	Sets given clip area into image. More...

Protected Member Functions inherited from FIFE::RenderBackend
void	clearClipArea ()
	Clears any possible clip areas. More...

Additional Inherited Members
Static Public Member Functions inherited from FIFE::DynamicSingleton< RenderBackend >
static RenderBackend *	instance ()

Protected Attributes inherited from FIFE::RenderBackend
SDL_Surface *	m_screen

SDL_Surface *	m_target

bool	m_compressimages

bool	m_useframebuffer

bool	m_usenpot

bool	m_isalphaoptimized

bool	m_iscolorkeyenabled

SDL_Color	m_colorkey

ScreenMode	m_screenMode

SDL_PixelFormat	m_rgba_format

bool	m_isbackgroundcolor

SDL_Color	m_backgroundcolor

bool	m_isMipmapping

TextureFiltering	m_textureFilter

int32_t	m_maxAnisotropy

bool	m_monochrome

bool	m_isDepthBuffer

float	m_alphaValue

std::stack< ClipInfo >	m_clipstack

ClipInfo	m_guiClip

Detailed Description

The main class of the SDL-based renderer.

See also: RenderBackend

Definition at line 43 of file renderbackendsdl.h.

Constructor & Destructor Documentation

FIFE::RenderBackendSDL::RenderBackendSDL ( const SDL_Color & colorkey )

Definition at line 47 of file renderbackendsdl.cpp.

FIFE::RenderBackendSDL::~RenderBackendSDL ( )

virtual

Definition at line 51 of file renderbackendsdl.cpp.

References FIFE::RenderBackend::deinit().

Member Function Documentation

void FIFE::RenderBackendSDL::addImageToArray	(	uint32_t	id,
		const Rect &	rec,
		float const *	st,
		uint8_t	alpha,
		uint8_t const *	rgba
	)

virtual

Add the Image data to the array.

Implements FIFE::RenderBackend.

Definition at line 192 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::attachRenderTarget	(	ImagePtr &	img,
		bool	discard
	)

virtual

Attaches given image as a new render surface.

Implements FIFE::RenderBackend.

Definition at line 486 of file renderbackendsdl.cpp.

References FIFE::Image::getArea(), FIFE::Image::getSurface(), FIFE::RenderBackend::m_target, and setClipArea().

void FIFE::RenderBackendSDL::captureScreen ( const std::string & filename )

virtual

Creates a Screenshot and saves it to a file.

Implements FIFE::RenderBackend.

Definition at line 354 of file renderbackendsdl.cpp.

References FIFE::BMASK, FIFE::RenderBackend::getHeight(), FIFE::RenderBackend::getWidth(), FIFE::GMASK, FIFE::RenderBackend::m_screen, FIFE::NULLMASK, FIFE::RMASK, and FIFE::Image::saveAsPng().

Referenced by captureScreen().

Here is the caller graph for this function:

void FIFE::RenderBackendSDL::captureScreen	(	const std::string &	filename,
		uint32_t	width,
		uint32_t	height
	)

virtual

Creates a Screenshot with the given size(w,h) and saves it to a file.

Implements FIFE::RenderBackend.

Definition at line 373 of file renderbackendsdl.cpp.

References FIFE::AMASK, FIFE::BMASK, captureScreen(), FIFE::RenderBackend::getHeight(), FIFE::RenderBackend::getWidth(), FIFE::GMASK, FIFE::RenderBackend::m_screen, FIFE::RMASK, and FIFE::Image::saveAsPng().

void FIFE::RenderBackendSDL::changeBlending	(	int32_t	scr,
		int32_t	dst
	)

virtual

Change the Blendingmodel.

Implements FIFE::RenderBackend.

Definition at line 186 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::changeRenderInfos	(	RenderDataType	type,
		uint16_t	elements,
		int32_t	src,
		int32_t	dst,
		bool	light,
		bool	stentest,
		uint8_t	stenref,
		GLConstants	stenop,
		GLConstants	stenfunc,
		OverlayType	otype = `OVERLAY_TYPE_NONE`
	)

virtual

Dirty helper function to change the render infos.

Implements FIFE::RenderBackend.

Definition at line 195 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::clearBackBuffer ( )

virtual

Forces a clear of the backbuffer.

Implements FIFE::RenderBackend.

Definition at line 74 of file renderbackendsdl.cpp.

References FIFE::RenderBackend::getHeight(), FIFE::RenderBackend::getWidth(), and FIFE::RenderBackend::m_screen.

Image * FIFE::RenderBackendSDL::createImage ( IResourceLoader * loader = 0 )

virtual

Implements FIFE::RenderBackend.

Definition at line 145 of file renderbackendsdl.cpp.

Image * FIFE::RenderBackendSDL::createImage	(	const std::string &	name,
		IResourceLoader *	loader = `0`
	)

virtual

Implements FIFE::RenderBackend.

Definition at line 149 of file renderbackendsdl.cpp.

Image * FIFE::RenderBackendSDL::createImage	(	const uint8_t *	data,
		uint32_t	width,
		uint32_t	height
	)

virtual

Creates an Image suitable for this renderbackend.

Parameters

data	Pointer to the imagedata (needs to be in RGBA, 8 bits per channel).
width	Width of the image.
height	Height of the image.

Returns: The new Image.

Implements FIFE::RenderBackend.

Definition at line 161 of file renderbackendsdl.cpp.

Image * FIFE::RenderBackendSDL::createImage	(	const std::string &	name,
		const uint8_t *	data,
		uint32_t	width,
		uint32_t	height
	)

virtual

Implements FIFE::RenderBackend.

Definition at line 165 of file renderbackendsdl.cpp.

Image * FIFE::RenderBackendSDL::createImage ( SDL_Surface * surface )

virtual

Helper function to create images from SDL_Surfaces.

Takes ownership over the surface.

Parameters

surface The surface to convert.

Returns: The new Image.

Implements FIFE::RenderBackend.

Definition at line 153 of file renderbackendsdl.cpp.

Image * FIFE::RenderBackendSDL::createImage	(	const std::string &	name,
		SDL_Surface *	surface
	)

virtual

Implements FIFE::RenderBackend.

Definition at line 157 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::createMainScreen	(	const ScreenMode &	mode,
		const std::string &	title,
		const std::string &	icon
	)

virtual

Creates the mainscreen (the display window).

Parameters

mode	The ScreenMode to use.

See also: FIFE::ScreenMode.

Parameters

title	The window title to use.
icon	The window icon to use.

Implements FIFE::RenderBackend.

Definition at line 84 of file renderbackendsdl.cpp.

References setScreenMode().

void FIFE::RenderBackendSDL::detachRenderTarget ( )

virtual

Detaches current render surface.

Implements FIFE::RenderBackend.

Definition at line 491 of file renderbackendsdl.cpp.

References FIFE::RenderBackend::m_screen, and FIFE::RenderBackend::m_target.

void FIFE::RenderBackendSDL::disableScissorTest ( )

virtual

Disables scissor test on the render backend.

Implements FIFE::RenderBackend.

Definition at line 351 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::drawLightPrimitive	(	const Point &	p,
		uint8_t	intensity,
		float	radius,
		int32_t	subdivisions,
		float	xstretch,
		float	ystretch,
		uint8_t	red,
		uint8_t	green,
		uint8_t	blue
	)

virtual

Draws a light primitive that based on a triangle fan.

Implements FIFE::RenderBackend.

Definition at line 345 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::drawLine	(	const Point &	p1,
		const Point &	p2,
		uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	a = `255`
	)

virtual

Draws line between given points with given RGBA.

Implements FIFE::RenderBackend.

Definition at line 202 of file renderbackendsdl.cpp.

References ABS, putPixel(), FIFE::PointType2D< T >::x, and FIFE::PointType2D< T >::y.

Referenced by drawRectangle(), drawTriangle(), and drawVertex().

Here is the caller graph for this function:

void FIFE::RenderBackendSDL::drawQuad	(	const Point &	p1,
		const Point &	p2,
		const Point &	p3,
		const Point &	p4,
		uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	a = `255`
	)

virtual

Draws quad between given points with given RGBA.

Implements FIFE::RenderBackend.

Definition at line 329 of file renderbackendsdl.cpp.

References fillRectangle(), FIFE::PointType2D< T >::x, and FIFE::PointType2D< T >::y.

void FIFE::RenderBackendSDL::drawRectangle	(	const Point &	p,
		uint16_t	w,
		uint16_t	h,
		uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	a = `255`
	)

virtual

Draws an axis parallel rectangle.

Implements FIFE::RenderBackend.

Definition at line 300 of file renderbackendsdl.cpp.

References drawLine(), FIFE::PointType2D< T >::x, and FIFE::PointType2D< T >::y.

void FIFE::RenderBackendSDL::drawTriangle	(	const Point &	p1,
		const Point &	p2,
		const Point &	p3,
		uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	a = `255`
	)

virtual

Draws triangle between given points with given RGBA.

Implements FIFE::RenderBackend.

Definition at line 294 of file renderbackendsdl.cpp.

References drawLine().

void FIFE::RenderBackendSDL::drawVertex	(	const Point &	p,
		const uint8_t	size,
		uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	a = `255`
	)

virtual

Draws a quad that represents a vertex with given RGBA.

Implements FIFE::RenderBackend.

Definition at line 333 of file renderbackendsdl.cpp.

References drawLine(), FIFE::PointType2D< T >::x, and FIFE::PointType2D< T >::y.

void FIFE::RenderBackendSDL::enableScissorTest ( )

virtual

Enables scissor test on the render backend.

Implements FIFE::RenderBackend.

Definition at line 348 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::endFrame ( )

virtual

Called when a frame is finished and ready to be displayed.

Reimplemented from FIFE::RenderBackend.

Definition at line 140 of file renderbackendsdl.cpp.

References FIFE::RenderBackend::endFrame(), and FIFE::RenderBackend::m_screen.

void FIFE::RenderBackendSDL::fillRectangle	(	const Point &	p,
		uint16_t	w,
		uint16_t	h,
		uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	a = `255`
	)

virtual

Draws a filled axis parallel rectangle.

Implements FIFE::RenderBackend.

Definition at line 318 of file renderbackendsdl.cpp.

References FIFE::RenderBackend::m_target, FIFE::PointType2D< T >::x, and FIFE::PointType2D< T >::y.

Referenced by drawQuad().

Here is the caller graph for this function:

uint32_t FIFE::RenderBackendSDL::getLightingModel ( ) const

virtual

Gets the current light model.

Implements FIFE::RenderBackend.

Definition at line 173 of file renderbackendsdl.cpp.

const std::string & FIFE::RenderBackendSDL::getName ( ) const

virtual

The name of the renderbackend.

Returns: The name of this renderbackend.

Implements FIFE::RenderBackend.

Definition at line 55 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::init ( const std::string & driver )

virtual

Initializes the backend.

Implements FIFE::RenderBackend.

Definition at line 60 of file renderbackendsdl.cpp.

bool FIFE::RenderBackendSDL::putPixel	(	int32_t	x,
		int32_t	y,
		uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	a = `255`
	)

virtual

Writes pixel to given position.

Returns true, if pixel was written (not out of bounds)

Implements FIFE::RenderBackend.

Definition at line 198 of file renderbackendsdl.cpp.

References FIFE::RenderBackend::m_target, and FIFE::Image::putPixel().

Referenced by drawLine().

Here is the caller graph for this function:

void FIFE::RenderBackendSDL::renderGuiGeometry	(	const std::vector< GuiVertex > &	vertices,
		const std::vector< int > &	indices,
		const DoublePoint &	translation,
		ImagePtr	texture
	)