Serious Sam's Bogus Detour  2016/06/09
Engine documentation
Classes
Drawing

Classes

class  Texture2D
 A texture handle used for rendering PNG images. More...
 
class  TempTexture2D
 A refcounted texture handle. More...
 
class  Bitmap2D
 A bitmap handle used for rendering TGA images. More...
 
class  BitmapString
 A rendered string of text from a font. More...
 
class  BitmapFont
 A font that can be used to create BitmapString objects. More...
 
class  Sprite
 An animated sprite that can be rendered on the GUI. More...
 
class  SpriteBatch
 Rendering object for rendering things on the GUI. More...
 

Detailed Description


Class Documentation

class Texture2D

A texture handle used for rendering PNG images.

Public Member Functions

int32 GetWidth ()
 
int32 GetHeight ()
 

Member Function Documentation

int32 Texture2D::GetHeight ( )
int32 Texture2D::GetWidth ( )
class TempTexture2D

A refcounted texture handle.

Public Member Functions

int32 GetWidth ()
 
int32 GetHeight ()
 
Texture2DGetTexture ()
 

Member Function Documentation

int32 TempTexture2D::GetHeight ( )
Texture2D* TempTexture2D::GetTexture ( )
int32 TempTexture2D::GetWidth ( )
class Bitmap2D

A bitmap handle used for rendering TGA images.

Public Member Functions

int32 GetWidth ()
 
int32 GetHeight ()
 

Member Function Documentation

int32 Bitmap2D::GetHeight ( )
int32 Bitmap2D::GetWidth ( )
class BitmapString

A rendered string of text from a font.

Public Member Functions

int32 GetWidth ()
 
int32 GetHeight ()
 
void ResetColor ()
 
void SetColor (const vec4 &color)
 
void SetColorGradient (const vec4 &color1, const vec4 &color2, GradientDirection dir)
 

Member Function Documentation

int32 BitmapString::GetHeight ( )
int32 BitmapString::GetWidth ( )
void BitmapString::ResetColor ( )
void BitmapString::SetColor ( const vec4 color)
void BitmapString::SetColorGradient ( const vec4 color1,
const vec4 color2,
GradientDirection  dir 
)
class BitmapFont

A font that can be used to create BitmapString objects.

Public Member Functions

BitmapStringBuildText (const string &text, int32 width=-1, TextAlignment align=TextAlignment::Left)
 
vec2 MeasureText (string text, int32 width=-1)
 

Member Function Documentation

BitmapString* BitmapFont::BuildText ( const string text,
int32  width = -1,
TextAlignment  align = TextAlignment::Left 
)
vec2 BitmapFont::MeasureText ( string  text,
int32  width = -1 
)
class Sprite

An animated sprite that can be rendered on the GUI.

Public Member Functions

Texture2DGetTexture2D ()
 
uint32 GetLength ()
 
int32 GetWidth ()
 
int32 GetHeight ()
 
vec4 GetFrame (int32 time)
 

Member Function Documentation

vec4 Sprite::GetFrame ( int32  time)
int32 Sprite::GetHeight ( )
uint32 Sprite::GetLength ( )
Texture2D* Sprite::GetTexture2D ( )
int32 Sprite::GetWidth ( )
class SpriteBatch

Rendering object for rendering things on the GUI.

Public Member Functions

void Begin (int32 width, int32 height, float scale, bool grayscale=false)
 
void End ()
 
void SetGrayscale (bool grayscale)
 
void PushTransformation (const mat3 &transform, const vec2 &pivot)
 
void PushTransformation (const mat4 &transform)
 
void PopTransformation ()
 
void PushClipping (const vec4 &rect, bool inverse=false)
 
void PopClipping ()
 
void PauseClipping ()
 
void ResumeClipping ()
 
void DrawString (const vec2 &pos, BitmapString &string)
 
void DrawLine (const vec2 &from, const vec2 &to, float thickness, const vec4 &color)
 
void DrawSprite (const vec2 &pos, Sprite *sprite, uint32 time, const vec4 &color=vec4(1, 1, 1, 1))
 
void DrawSprite (Texture2D *tex, const vec4 &pos, const vec4 &src, const vec4 &color=vec4(1, 1, 1, 1))
 
void DrawSpriteRadial (const vec2 &pos, Sprite *sprite, uint32 time, float r, const vec4 &color=vec4(1, 1, 1, 1))
 
void DrawSpriteRadial (Texture2D *tex, const vec4 &pos, const vec4 &src, float r, const vec4 &color=vec4(1, 1, 1, 1))
 
void DrawRectangle (const vec4 &rect, const vec4 &color, int32 thickness=1)
 
void FillRectangle (const vec4 &rect, const vec4 &color)
 
void DrawUnitScene (const vec2 &pos, const vec2 &size, UnitScene *scene, uint32 time)
 

Member Function Documentation

void SpriteBatch::Begin ( int32  width,
int32  height,
float  scale,
bool  grayscale = false 
)
void SpriteBatch::DrawLine ( const vec2 from,
const vec2 to,
float  thickness,
const vec4 color 
)
void SpriteBatch::DrawRectangle ( const vec4 rect,
const vec4 color,
int32  thickness = 1 
)
void SpriteBatch::DrawSprite ( const vec2 pos,
Sprite sprite,
uint32  time,
const vec4 color = vec4(1, 1, 1, 1) 
)
void SpriteBatch::DrawSprite ( Texture2D tex,
const vec4 pos,
const vec4 src,
const vec4 color = vec4(1, 1, 1, 1) 
)
void SpriteBatch::DrawSpriteRadial ( const vec2 pos,
Sprite sprite,
uint32  time,
float  r,
const vec4 color = vec4(1, 1, 1, 1) 
)
void SpriteBatch::DrawSpriteRadial ( Texture2D tex,
const vec4 pos,
const vec4 src,
float  r,
const vec4 color = vec4(1, 1, 1, 1) 
)
void SpriteBatch::DrawString ( const vec2 pos,
BitmapString string 
)
void SpriteBatch::DrawUnitScene ( const vec2 pos,
const vec2 size,
UnitScene scene,
uint32  time 
)
void SpriteBatch::End ( )
void SpriteBatch::FillRectangle ( const vec4 rect,
const vec4 color 
)
void SpriteBatch::PauseClipping ( )
void SpriteBatch::PopClipping ( )
void SpriteBatch::PopTransformation ( )
void SpriteBatch::PushClipping ( const vec4 rect,
bool  inverse = false 
)
void SpriteBatch::PushTransformation ( const mat3 transform,
const vec2 pivot 
)
void SpriteBatch::PushTransformation ( const mat4 transform)
void SpriteBatch::ResumeClipping ( )
void SpriteBatch::SetGrayscale ( bool  grayscale)