Kigs Framework  Doc version 0.8
Open source multi purpose Rapid Application Development framework
Public Member Functions | Protected Member Functions | List of all members
DX11RenderingScreen Class Reference

#include <DX11RenderingScreen.h>

Inheritance diagram for DX11RenderingScreen:
RenderingScreen CoreModifiable GenericRefCountedBaseClass

Public Member Functions

bool SetActive (TravState *state) override
 active the screen More...
 
void Release (TravState *state) override
 release the screen
 
void Resize (kfloat sizeX, kfloat sizeY) override
 resize the screen More...
 
virtual void SetWindowByHandle (void *PtrToHandle) override
 Set the target window handle of the rendering. If null, the Window name passed through "ParentWindowName" will be used. More...
 
virtual void * GetContextHandle () override
 get the target window handle of the rendering.
 
- Public Member Functions inherited from RenderingScreen
void GetRotation (kfloat &rot)
 get the rotation of the screen More...
 
void GetSize (kfloat &sizeX, kfloat &sizeY)
 get the size of the screen More...
 
void GetDesignSize (kfloat &dsizeX, kfloat &dsizeY)
 get the design size of the screen : the resolution the graphics shown on screen were designed for More...
 
bool IsInit ()
 check if the screen has been initialized More...
 
bool GetDataInTouchSupport (const touchPosInfos &posin, touchPosInfos &pout)
 convert touch pos in local "touch support" coordinates More...
 
- Public Member Functions inherited from CoreModifiable
void Init ()
 Modifiable managmenent.
 
void EmptyItemList ()
 remove all items (sons)
 
CMSP GetInstanceByPath (const std::string &path)
 return the instance corresponding to the given path in sons tree
 
std::string GetRuntimeID () const
 ID.
 
CoreModifiableAttributegetAttribute (KigsID labelid) const
 Attribute management.
 
u32 getNbArrayElements (KigsID attributeLabel) const
 return element count for an array type attribute
 
template<typename attribute_type , typename value_type >
attribute_type * AddDynamicAttribute (KigsID ID, const value_type &value)
 Dynamic attribute management.
 
const kigs::unordered_map< KigsID, ModifiableMethodStruct > * GetMethods ()
 Method management.
 
bool aggregateWith (CMSP &item, ItemPosition pos=Last)
 Aggregate management.
 
void flagAsNotificationCenterRegistered ()
 Flags.
 
void InitParametersFromList (const std::vector< CoreModifiableAttribute * > *params)
 Utility. More...
 
virtual void ProtectedDestroy ()
 Destroy method decrement refcounter and delete instance if no more used. More...
 
virtual void addUser (CoreModifiable *user)
 add the given parent to list
 
virtual void removeUser (CoreModifiable *user)
 remove user (parent)
 
virtual bool addItem (const CMSP &item, ItemPosition pos=Last)
 add item at first or last position
 
virtual bool removeItem (const CMSP &item)
 remove item (son)
 

Protected Member Functions

void InitModifiable () override
 default modifiable init : set all initparams to readonly and set initflag to true More...
 
void UninitModifiable () override
 called when InitModifiable has failled : reset read/write flag on all init params More...
 
- Protected Member Functions inherited from CoreModifiable
void UpdateAggregates (const Timer &timer, void *addParam)
 Internals.
 
void Export (std::vector< CoreModifiable * > &savedList, XMLNode *currentNode, bool recursive, ExportSettings *settings)
 Export. More...
 
CoreModifiableAttributeGenericCreateDynamicAttribute (CoreModifiable::ATTRIBUTE_TYPE type, KigsID ID)
 create and add dynamic attribute except arrays
 

Additional Inherited Members

- Static Public Member Functions inherited from CoreModifiable
static std::vector< CMSP > GetRootInstances (const KigsID &cid, bool exactTypeOnly=false)
 static method : return the set of all root instances of the given type
 
static void Append (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (const std::string &filename, CoreModifiable *toexport, bool recursive=false, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static XMLNodeExportToXMLNode (CoreModifiable *toexport, XML *owner_xml_file, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML Node. if recursive flag is set to true, export also all sons tree More...
 
static std::string ExportToXMLString (CoreModifiable *toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the given CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static void Export (std::string &XMLString, const std::list< CoreModifiable * > &toexport, bool recursive, ExportSettings *settings=nullptr)
 static method to export the several CoreModifiable to an XML file. if recursive flag is set to true, export also all sons tree More...
 
static CMSP Import (const std::string &filename, bool noInit=false, bool keepImportFileName=false, ImportState *state=nullptr, const std::string &override_name="")
 return an new CoreModifiable instance using the description found in XML file given by name
 
static CMSP GetInstanceByGlobalPath (const std::string &path)
 static method : return the instance corresponding to the given path, and given search start
 
static void debugPrintfFullTree (int maxindent=3)
 Editor. More...
 
- Static Protected Member Functions inherited from CoreModifiable
template<typename StringType >
static CMSP Import (XMLNodeTemplate< StringType > *currentNode, CoreModifiable *currentModifiable, ImportState &importState)
 recusrive method to add sons and attributes found in the XML file
 
- Protected Attributes inherited from RenderingScreen
bool mIsInit
 TRUE if the screen has been initialized.
 
maInt mBitsPerPixel
 size of a pixel in bit
 
maInt mBitsPerZ
 size of the Z value in bit
 
maUInt mSizeX
 size of the screen on x axis
 
maUInt mSizeY
 size of the screen on y axis
 
maUInt mDesignSizeX
 design size of the screen on x axis
 
maUInt mDesignSizeY
 design size of the screen on y axis
 
maBool mIsOffScreen
 ?
 
maString mParentWindowName
 name of the parent windows
 
maBool mVSync
 TRUE if I wait for the VSync.
 
maFloat mBrightness
 brightness : between -16 (black) and 16 (white)
 
maVect3DF mBackDropColor
 back drop color
 
maFloat mRotation
 screen orientation (for handheld devices)
 
maBool mDontClear
 indicate the screen don't need clear (camera should still clear their part of screen)
 
maBool mNeedDoubleBuffer
 double buffer on/off
 

Detailed Description

DX11 implementation of RenderingScreen.

Member Function Documentation

◆ InitModifiable()

void DX11RenderingScreen::InitModifiable ( )
overrideprotectedvirtual

default modifiable init : set all initparams to readonly and set initflag to true

already done ? then return

Reimplemented from RenderingScreen.

◆ Resize()

void DX11RenderingScreen::Resize ( kfloat  sizeX,
kfloat  sizeY 
)
overridevirtual

resize the screen

Parameters
sizeX: new size on the x axis
sizeY: new size on the y axis

Implements RenderingScreen.

◆ SetActive()

bool DX11RenderingScreen::SetActive ( TravState state)
overridevirtual

active the screen

Returns
return true if rendering screen can be activated

Reimplemented from RenderingScreen.

◆ SetWindowByHandle()

virtual void DX11RenderingScreen::SetWindowByHandle ( void *  PtrToHandle)
inlineoverridevirtual

Set the target window handle of the rendering. If null, the Window name passed through "ParentWindowName" will be used.

Parameters
PtrToHandle: window handle

Implements RenderingScreen.

◆ UninitModifiable()

void DX11RenderingScreen::UninitModifiable ( )
overrideprotectedvirtual

called when InitModifiable has failled : reset read/write flag on all init params

not init ? return

Reimplemented from CoreModifiable.


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