FIFE::RenderBackendSDL Class Reference

#include <renderbackendsdl.h>

Inheritance diagram for FIFE::RenderBackendSDL:
Inheritance graph
[legend]
Collaboration diagram for FIFE::RenderBackendSDL:
Collaboration graph
[legend]

List of all members.

Public Member Functions

const std::string & getName () const
void startFrame ()
void endFrame ()
void init (const std::string &driver)
void clearBackBuffer ()
void setLightingModel (unsigned int lighting)
unsigned int getLightingModel () const
void enableLighting ()
void disableLighting ()
void setLighting (float red, float green, float blue, float alpha)
void resetLighting ()
void enableStencilTest ()
void disableStencilTest ()
uint8_t getStencilRef () const
void enableAlphaTest ()
void disableAlphaTest ()
void setAlphaTest (float ref_alpha)
void changeBlending (int scr, int dst)
ImagecreateMainScreen (const ScreenMode &mode, const std::string &title, const std::string &icon)
ImagesetScreenMode (const ScreenMode &mode)
ImagecreateImage (const uint8_t *data, unsigned int width, unsigned int height)
ImagecreateImage (SDL_Surface *surface)

Detailed Description

The main class of the SDL-based renderer.

See also:
RenderBackend

Definition at line 43 of file renderbackendsdl.h.


Member Function Documentation

void FIFE::RenderBackendSDL::changeBlending ( int  scr,
int  dst 
) [virtual]

Change the Blendingmodel.

Implements FIFE::RenderBackend.

Definition at line 193 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::clearBackBuffer (  )  [virtual]

Forces a clear of the backbuffer

Implements FIFE::RenderBackend.

Definition at line 68 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 140 of file renderbackendsdl.cpp.

Image * FIFE::RenderBackendSDL::createImage ( const uint8_t *  data,
unsigned int  width,
unsigned int  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 144 of file renderbackendsdl.cpp.

Image * 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:
tite The window title to use.
icon The window icon to use.
Returns:
The new Screen Image

Implements FIFE::RenderBackend.

Definition at line 78 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::disableAlphaTest (  )  [virtual]

Disable the stencil test.

Implements FIFE::RenderBackend.

Definition at line 187 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::disableLighting (  )  [virtual]

Disable the lighting.

Implements FIFE::RenderBackend.

Definition at line 159 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::disableStencilTest (  )  [virtual]

Disable the stencil test.

Implements FIFE::RenderBackend.

Definition at line 171 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::enableAlphaTest (  )  [virtual]

Enable the alpha test.

Implements FIFE::RenderBackend.

Definition at line 184 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::enableLighting (  )  [virtual]

Enable the lighting.

Implements FIFE::RenderBackend.

Definition at line 156 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::enableStencilTest (  )  [virtual]

Enable the stencil test.

Implements FIFE::RenderBackend.

Definition at line 168 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::endFrame (  )  [virtual]

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

Implements FIFE::RenderBackend.

Definition at line 136 of file renderbackendsdl.cpp.

unsigned int FIFE::RenderBackendSDL::getLightingModel (  )  const [virtual]

Gets the current light model.

Implements FIFE::RenderBackend.

Definition at line 152 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 49 of file renderbackendsdl.cpp.

uint8_t FIFE::RenderBackendSDL::getStencilRef (  )  const [virtual]

Return the reference value for the stencil test.

Implements FIFE::RenderBackend.

Definition at line 180 of file renderbackendsdl.cpp.

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

Initializes the backend.

Implements FIFE::RenderBackend.

Definition at line 54 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::resetLighting (  )  [virtual]

Reset lighting with default values.

Implements FIFE::RenderBackend.

Definition at line 165 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::setAlphaTest ( float  ref_alpha  )  [virtual]

Set reference for the alpha test.

Implements FIFE::RenderBackend.

Definition at line 190 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::setLighting ( float  red,
float  green,
float  blue,
float  alpha 
) [virtual]

Set colors for lighting

Implements FIFE::RenderBackend.

Definition at line 162 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::setLightingModel ( unsigned int  lighting  )  [virtual]

Initializes the light.

Implements FIFE::RenderBackend.

Definition at line 148 of file renderbackendsdl.cpp.

Image * FIFE::RenderBackendSDL::setScreenMode ( const ScreenMode &  mode  )  [virtual]

Sets the mainscreen display mode.

Parameters:
mode The ScreenMode to change the display to.
See also:
FIFE::ScreenMode.
Returns:
The new Screen Image

Implements FIFE::RenderBackend.

Definition at line 93 of file renderbackendsdl.cpp.

void FIFE::RenderBackendSDL::startFrame (  )  [virtual]

Called when a new frame starts.

Implements FIFE::RenderBackend.

Definition at line 133 of file renderbackendsdl.cpp.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 13:05:18 2011 for FIFE by  doxygen 1.6.3