Kicking it Olde Sküül! Burgerlib on Github Follow Olde Sküül on Twitter Burgerbecky on LinkedIn Burgerbecky on LinkedIn
Loading...
Searching...
No Matches
Burger::Effect2D Class Referenceabstract
Inheritance diagram for Burger::Effect2D:
Collaboration diagram for Burger::Effect2D:

Classes

struct  Vertex
 

Public Member Functions

const Burger::StaticRTTIget_StaticRTTI (void) const noexcept override
 Get the description to the class.
 
 Effect2D (Display *pDisplay, const uint_t *pVertexMembers)
 Default constructor for an Effect2D.
 
virtual void SetPosition (float fX, float fY, float fWidth, float fHeight)=0
 Set the location of where to draw the 2D texture.
 
virtual void SetPosition (const Vector4D_t *pPosition)=0
 Set the location of where to draw the 2D texture.
 
- Public Member Functions inherited from Burger::Effect
 Effect ()
 Standard constructor.
 
virtual ~Effect ()
 Standard destructor.
 
virtual void Release (Display *pDisplay) override
 Release the shaders.
 
D3DPixelShader * GetPixelShader360 (void) const
 Get the pointer to the Xbox 360 Pixel shader instance.
 
D3DVertexShader * GetVertexShader360 (void) const
 Get the pointer to the Xbox 360 Vertex shader instance.
 
D3DDevice * GetDevice360 (void) const
 Get the pointer to the Xbox 360 device instance.
 
uint_t GetProgramID (void) const
 Get the OpenGL program ID for the compiled effect.
 
IDirect3DPixelShader9 * GetPixelShaderDX9 (void) const
 Get the pointer to the DirectX 9 Pixel shader instance.
 
IDirect3DVertexShader9 * GetVertexShaderDX9 (void) const
 Get the pointer to the DirectX 9 Vertex shader instance.
 
IDirect3DDevice9 * GetDeviceDX9 (void) const
 Get the pointer to the DirectX 9 device instance.
 
- Public Member Functions inherited from Burger::DisplayObject
DisplayObjectGetNext (void) const
 Get the next display object in the global linked list.
 
DisplayObjectGetPrevious (void) const
 Get the previous display object in the global linked list.
 
virtual uint_t CheckLoad (Display *pDisplay)=0
 Load data onto the video display card.
 
- Public Member Functions inherited from Burger::ReferenceCounter
const Burger::StaticRTTIget_StaticRTTI (void) const noexcept override
 Get the description to the class.
 
 ReferenceCounter () noexcept
 Sets the reference count to zero.
 
virtual ~ReferenceCounter ()
 Destructor.
 
void AddRef (void) noexcept
 Increase the reference count by 1.
 
void Release (void) noexcept
 Decrease the reference count by 1.
 
- Public Member Functions inherited from Burger::Base
const char * get_class_name (void) const noexcept
 Get the name of the class.
 
virtual ~Base () noexcept=default
 Destructor.
 

Static Public Attributes

static const Burger::StaticRTTI g_StaticRTTI
 Default constructor for an Effect2DOpenGL.
 
- Static Public Attributes inherited from Burger::Effect
static const Burger::StaticRTTI g_StaticRTTI
 The global description of the class.
 
- Static Public Attributes inherited from Burger::DisplayObject
static const Burger::StaticRTTI g_StaticRTTI
 The global description of the class.
 
- Static Public Attributes inherited from Burger::ReferenceCounter
static const Burger::StaticRTTI g_StaticRTTI
 The global description of the class.
 
- Static Public Attributes inherited from Burger::Base
static const Burger::StaticRTTI g_StaticRTTI
 The global description of the class.
 

Protected Attributes

int_t m_iEffect2DPosition
 (OpenGL only) Index for the position
 
- Protected Attributes inherited from Burger::Effect
D3DPixelShader * m_pPixelShader
 (Xbox360 only) Pixel shader
 
D3DVertexShader * m_pVertexShader
 (Xbox360 only) Vertex shader
 
D3DDevice * m_pDevice
 (Xbox360 only) parent device
 
union { 
 
   struct { 
 
      IDirect3DPixelShader9 *   m_pPixelShader 
 DirectX9 Pixel shader. More...
 
      IDirect3DVertexShader9 *   m_pVertexShader 
 DirectX9 Vertex shader. More...
 
      IDirect3DDevice9 *   m_pDevice 
 DirectX9 parent device. More...
 
   }   m_DX9 
 DirectX 9 specific data. More...
 
   struct { 
 
      uint_t   m_uProgramID 
 OpenGL Program ID for the compiled shader. More...
 
   }   m_GL 
 OpenGL specific data. More...
 
m_ShaderData 
 Union of vertex/pixel shader data.
 
- Protected Attributes inherited from Burger::DisplayObject
DisplayObjectm_pNextDisplayObject
 Pointer to the next DisplayObject.
 
DisplayObjectm_pPrevDisplayObject
 Pointer to the previous DisplayObject.
 

Private Member Functions

 Effect2D (const Effect2D &)=delete
 
Effect2Doperator= (const Effect2D &)=delete
 
 Effect2D (Effect2D &&)=delete
 
Effect2Doperator= (Effect2D &&)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from Burger::DisplayObject
static DisplayObjectGetFirstObject (void)
 Get the first display object in the global linked list.
 
static void ReleaseAll (Display *pDisplay)
 Release all display objects.
 
- Public Attributes inherited from Burger::Effect
- Protected Member Functions inherited from Burger::Effect
void ReleaseGL (void)
 Release the OpenGL data.
 
void ReleaseDX9 (void)
 Release the DirectX 9 data.
 
- Protected Member Functions inherited from Burger::DisplayObject
 DisplayObject (void)
 Add this display object to the global linked list.
 
virtual ~DisplayObject ()
 Remove this display object from the global linked list.
 
- Static Protected Attributes inherited from Burger::DisplayObject
static DisplayObjectg_pHead = NULL
 Global pointer to the linked list of display objects.
 

Constructor & Destructor Documentation

◆ Effect2D() [1/3]

Burger::Effect2D::Effect2D ( const Effect2D & )
privatedelete

◆ Effect2D() [2/3]

Burger::Effect2D::Effect2D ( Effect2D && )
privatedelete

◆ Effect2D() [3/3]

Burger::Effect2D::Effect2D ( Display * pDisplay,
const uint_t * pVertexMembers )

Default constructor for an Effect2D.


Parameters
pDisplayPointer to the current display
pVertexMembersPointer to a description to the vertex entries

Member Function Documentation

◆ get_StaticRTTI()

const Burger::StaticRTTI * Burger::Effect2D::get_StaticRTTI ( void ) const
overridevirtualnoexcept

Get the description to the class.


This virtual function will pull the pointer to the StaticRTTI instance that has the name of the class. Due to it being virtual, it will be the name of the most derived class.

Returns
Pointer to a global, read only instance of StaticRTTI for the true class

Reimplemented from Burger::Effect.

Reimplemented in Burger::Effect2DDX9, and Burger::Effect2DOpenGL.

◆ operator=() [1/2]

Effect2D & Burger::Effect2D::operator= ( const Effect2D & )
privatedelete

◆ operator=() [2/2]

Effect2D & Burger::Effect2D::operator= ( Effect2D && )
privatedelete

◆ SetPosition() [1/2]

void BURGER_API Burger::Effect2D::SetPosition ( const Vector4D_t * pPosition)
pure virtual

Set the location of where to draw the 2D texture.


Parameters
pPositionPointer to a vector with an X coordinate from 0.0f to 1.0f, a Y coordinate from 0.0f to 1.0f, a width of the texture from 0.0f to 1.0f, a height of the texture from 0.0f to 1.0f

Implemented in Burger::Effect2DDX9, and Burger::Effect2DOpenGL.

◆ SetPosition() [2/2]

void BURGER_API Burger::Effect2D::SetPosition ( float fX,
float fY,
float fWidth,
float fHeight )
pure virtual

Set the location of where to draw the 2D texture.


Parameters
fXX coordinate from 0.0f to 1.0f
fYY coordinate from 0.0f to 1.0f
fWidthwidth of the texture from 0.0f to 1.0f
fHeightheight of the texture from 0.0f to 1.0f

Implemented in Burger::Effect2DDX9, and Burger::Effect2DOpenGL.

Member Data Documentation

◆ g_StaticRTTI

const Burger::StaticRTTI Burger::Effect2D::g_StaticRTTI
static

Default constructor for an Effect2DOpenGL.



The global description of the class

This record contains the name of this class and a reference to the parent

◆ m_iEffect2DPosition

int_t Burger::Effect2D::m_iEffect2DPosition
protected

(OpenGL only) Index for the position