MxOmniCreateParam Class Reference

[AI] Encapsulates parameters required to initialize the core Omni engine. More...

#include <mxomnicreateparam.h>

Inheritance diagram for MxOmniCreateParam:

Collaboration diagram for MxOmniCreateParam:

Public Member Functions
	MxOmniCreateParam (const char *p_mediaPath, struct HWND__ *p_windowHandle, MxVideoParam &p_vparam, MxOmniCreateFlags p_flags)
	[AI] Constructs a parameter set for initializing the Omni engine. More...
MxOmniCreateFlags &	CreateFlags ()
	[AI] Access/modify the creation flags. More...
const MxString &	GetMediaPath () const
	[AI] Gets the media/resource directory path. More...
const HWND	GetWindowHandle () const
	[AI] Returns the handle to the rendering window. More...
MxVideoParam &	GetVideoParam ()
	[AI] Access the detailed video parameter structure (for modification). More...
const MxVideoParam &	GetVideoParam () const
	[AI] Fetch immutable video parameter struct. More...
Public Member Functions inherited from MxParam
virtual	~MxParam ()
	[AI] Virtual destructor for safe polymorphic deletion of derived parameter objects. More...

Detailed Description

[AI] Encapsulates parameters required to initialize the core Omni engine.

[AI] MxOmniCreateParam gathers all required data for initializing the game engine including the media path, main window handle, video/graphics settings, and a set of engine behavior flags. It subclasses MxParam for easy passing in generic initialization APIs.

Definition at line 19 of file mxomnicreateparam.h.

Constructor & Destructor Documentation

MxOmniCreateParam()

MxOmniCreateParam::MxOmniCreateParam	(	const char *	p_mediaPath,
		struct HWND__ *	p_windowHandle,
		MxVideoParam &	p_vparam,
		MxOmniCreateFlags	p_flags
	)

[AI] Constructs a parameter set for initializing the Omni engine.

Parameters

p_mediaPath	[AI] Path to the media/resources directory.
p_windowHandle	[AI] Handle to the parent window for rendering output. Expected to be a valid HWND.
p_vparam	[AI] Reference to a video parameter structure describing video mode and display options.
p_flags	[AI] Engine creation flags (see MxOmniCreateFlags) determining specific options for engine startup.

[AI] This constructor sets all required information for creating and initializing the game engine.

Definition at line 9 of file mxomnicreateparam.cpp.

Member Function Documentation

CreateFlags()

MxOmniCreateFlags & MxOmniCreateParam::CreateFlags ( )

inline

[AI] Access/modify the creation flags.

Returns

[AI] Reference to internal creation flags for enabling/disabling engine features.

Definition at line 40 of file mxomnicreateparam.h.

GetMediaPath()

const MxString & MxOmniCreateParam::GetMediaPath ( ) const

inline

[AI] Gets the media/resource directory path.

Returns

[AI] Immutable reference to the string holding the absolute or relative resource path.

Definition at line 46 of file mxomnicreateparam.h.

GetVideoParam() [1/2]

MxVideoParam & MxOmniCreateParam::GetVideoParam ( )

inline

[AI] Access the detailed video parameter structure (for modification).

Returns

[AI] Reference to the engine's video parameter configuration (see MxVideoParam).

Definition at line 58 of file mxomnicreateparam.h.

GetVideoParam() [2/2]

const MxVideoParam & MxOmniCreateParam::GetVideoParam ( ) const

inline

[AI] Fetch immutable video parameter struct.

Returns

[AI] Const reference to the engine's video parameter configuration (see MxVideoParam).

Definition at line 64 of file mxomnicreateparam.h.

GetWindowHandle()

const HWND MxOmniCreateParam::GetWindowHandle ( ) const

inline

[AI] Returns the handle to the rendering window.

Returns

[AI] Handle (HWND) to the window that the engine will use for output.

Definition at line 52 of file mxomnicreateparam.h.

---

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

• mxomnicreateparam.h
• mxomnicreateparam.cpp