ParaScripting::ParaEngine Class Reference
[ParaEngine]

List of all members.

---

Detailed Description

global game engine related functions, such as ParaEngineCore interface, copy right information, simple water marking

Static Public Member Functions
static ParaAttributeObject	GetAttributeObject ()
	get the attribute object of ParaEngine settings
static void	GetAttributeObject_ (ParaAttributeObject &output)
	for API exportation.
static string	GetVersion ()
	get ParaEngine version
static bool	ForceRender ()
	render the current frame and does not return until everything is presented to screen.
static bool	Sleep (float fSeconds)
	cause the main thread to sleep for the specified seconds.
static bool	SaveParaXMesh (const char *filename, ParaAssetObject &xmesh, bool bBinaryEncoding)
	save an existing mesh to file.
static ParaAssetObject	GetRenderTarget ()
	return the current render target.
static bool	SetRenderTarget (ParaAssetObject &pRenderTarget)
	set the render target of the object.
static bool	StretchRect (ParaAssetObject &pSrcRenderTarget, ParaAssetObject &pDestRenderTarget)
	Copy render target content from one surface to another.
static bool	DrawQuad ()
	draw a full screen quad.
static bool	SetVertexDeclaration (int nIndex)
	Set declaration by id enum VERTEX_DECLARATION { S0_POS_TEX0, // all data in stream 0: position and tex0 S0_POS_NORM_TEX0, // all data in stream 0: position, normal and tex0 S0_POS_NORM_TEX0_INSTANCED, // all data in stream 0: position, normal and tex0, stream1:instanced data S0_POS_TEX0_COLOR, // all data in stream 0: position, tex0 and color S0_S1_S2_OCEAN_FFT, // for FFT ocean S0_S1_S2_S3_OCEAN_FFT, // for FFT ocean with terrain height field S0_POS_NORM_TEX0_TEX1, // all data in stream 0: position, normal tex0 and tex1 MAX_DECLARATIONS_NUM, };.

---

Member Function Documentation

static void ParaScripting::ParaEngine::GetAttributeObject_

(

ParaAttributeObject &

output

)

[static]

for API exportation.

static bool ParaScripting::ParaEngine::ForceRender

(

)

[static]

render the current frame and does not return until everything is presented to screen.

this function is usually used to draw the animated loading screen.

static bool ParaScripting::ParaEngine::Sleep

(

float

fSeconds

)

[static]

cause the main thread to sleep for the specified seconds.

static bool ParaScripting::ParaEngine::SaveParaXMesh	(	const char *	filename,
		ParaAssetObject &	xmesh,
		bool	bBinaryEncoding
	)			[static]

save an existing mesh to file.

Parameters:

	filename,:	file to be saved to. if this is "", the xmesh entity's file name will be used and appended with ".x"
	xmesh,:	ParaX mesh object to export.
	bBinaryEncoding,:	true to use binary encoding.

Returns:

: return true if succeeds.

static ParaAssetObject ParaScripting::ParaEngine::GetRenderTarget

(

)

[static]

return the current render target.

calling this function a second time will make the returned object from the previous call invalid.

static bool ParaScripting::ParaEngine::SetRenderTarget

(

ParaAssetObject &

pRenderTarget

)

[static]

set the render target of the object.

static bool ParaScripting::ParaEngine::StretchRect	(	ParaAssetObject &	pSrcRenderTarget,
		ParaAssetObject &	pDestRenderTarget
	)			[static]

Copy render target content from one surface to another.

they may be of different resolution

static bool ParaScripting::ParaEngine::DrawQuad

(

)

[static]

draw a full screen quad.

Note:

: one need to set the vertex declaration to be S0_POS_TEX0 prior to calling this function

static bool ParaScripting::ParaEngine::SetVertexDeclaration

(

int

nIndex

)

[static]

Set declaration by id enum VERTEX_DECLARATION { S0_POS_TEX0, // all data in stream 0: position and tex0 S0_POS_NORM_TEX0, // all data in stream 0: position, normal and tex0 S0_POS_NORM_TEX0_INSTANCED, // all data in stream 0: position, normal and tex0, stream1:instanced data S0_POS_TEX0_COLOR, // all data in stream 0: position, tex0 and color S0_S1_S2_OCEAN_FFT, // for FFT ocean S0_S1_S2_S3_OCEAN_FFT, // for FFT ocean with terrain height field S0_POS_NORM_TEX0_TEX1, // all data in stream 0: position, normal tex0 and tex1 MAX_DECLARATIONS_NUM, };.

Parameters:

nIndex,:

value is in

See also:

VERTEX_DECLARATION

Returns:

: return true if successful.

---