[AI] Video parameter configuration for display and rendering, encapsulates resolution, palette, backbuffers, display flags, and device identifier. More...

#include <mxvideoparam.h>

Collaboration diagram for MxVideoParam:

[legend]

Public Member Functions
	MxVideoParam ()
	[AI] Construct MxVideoParam with default screen rectangle (640x480), no palette, zero backbuffers, default flags, and null device name. More...

	__declspec (dllexport) MxVideoParam(MxRect32 &p_rect
	[AI] Construct MxVideoParam specifying display rectangle, color palette, number of back buffers, and display flags. More...

	MxVideoParam (MxVideoParam &p_videoParam)
	[AI] Copy constructor, performs a deep copy of all fields including a duplicate of the device name string. More...

	~MxVideoParam ()
	[AI] Destructor, frees device name memory if used. [AI] More...

void	SetDeviceName (char *p_deviceId)
	[AI] Set the device name/id for this video parameter (e.g., a specific display adapter), making a deep copy of the input string. More...

MxVideoParam &	operator= (const MxVideoParam &p_videoParam)
	[AI] Assignment operator, performs deep copy (including device name string) of another instance. More...

MxVideoParamFlags &	Flags ()
	[AI] Access the video parameter flags (windowed/fullscreen, rendering mode, etc). More...

MxRect32 &	GetRect ()
	[AI] Get the rectangle specifying the display dimensions and screen area. More...

MxPalette *	GetPalette ()
	[AI] Get the palette used for rendering (may be NULL if not set). More...

void	SetPalette (MxPalette *p_palette)
	[AI] Assign the palette pointer (color indexing) for the video mode. More...

char *	GetDeviceName ()
	[AI] Get a pointer to the internal device name string (may be NULL). More...

MxU32	GetBackBuffers ()
	[AI] Get the number of backbuffers requested for this display mode. More...

void	SetBackBuffers (MxU32 p_backBuffers)
	[AI] Set the desired number of backbuffers (triple/double buffering). More...

Public Attributes
MxPalette *	p_palette

MxPalette MxULong	p_backBuffers

MxPalette MxULong MxVideoParamFlags &	p_flags

Detailed Description

[AI] Video parameter configuration for display and rendering, encapsulates resolution, palette, backbuffers, display flags, and device identifier.

Definition at line 14 of file mxvideoparam.h.

Constructor & Destructor Documentation

◆ MxVideoParam() [1/2]

MxVideoParam::MxVideoParam ( )

[AI] Construct MxVideoParam with default screen rectangle (640x480), no palette, zero backbuffers, default flags, and null device name.

Definition at line 12 of file mxvideoparam.cpp.

◆ MxVideoParam() [2/2]

MxVideoParam::MxVideoParam ( MxVideoParam & p_videoParam )

[AI] Copy constructor, performs a deep copy of all fields including a duplicate of the device name string.

Parameters

p_videoParam Source video parameter object to copy. [AI]

Definition at line 35 of file mxvideoparam.cpp.

◆ ~MxVideoParam()

MxVideoParam::~MxVideoParam ( )

[AI] Destructor, frees device name memory if used. [AI]

Definition at line 48 of file mxvideoparam.cpp.

Member Function Documentation

◆ __declspec()

MxVideoParam::__declspec ( dllexport ) &

[AI] Construct MxVideoParam specifying display rectangle, color palette, number of back buffers, and display flags.

Parameters

p_rect	Rectangle dimensions for the video output. [AI]
p_palette	Palette to use for video output. [AI]
p_backBuffers	Number of requested back buffers for double/triple buffering. [AI]
p_flags	Control flags such as windowed/fullscreen mode, hardware/software rendering etc. [AI]

◆ Flags()

MxVideoParamFlags & MxVideoParam::Flags ( )

inline

[AI] Access the video parameter flags (windowed/fullscreen, rendering mode, etc).

Returns: Modifiable reference to the flags object. [AI]

Definition at line 45 of file mxvideoparam.h.

◆ GetBackBuffers()

MxU32 MxVideoParam::GetBackBuffers ( )

inline

[AI] Get the number of backbuffers requested for this display mode.

Definition at line 64 of file mxvideoparam.h.

◆ GetDeviceName()

char * MxVideoParam::GetDeviceName ( )

inline

[AI] Get a pointer to the internal device name string (may be NULL).

Returns: Pointer to the null-terminated device id string, e.g. a DirectDraw device. [AI]

Definition at line 61 of file mxvideoparam.h.

◆ GetPalette()

MxPalette * MxVideoParam::GetPalette ( )

inline

[AI] Get the palette used for rendering (may be NULL if not set).

Returns: Pointer to the palette used currently. [AI]

Definition at line 53 of file mxvideoparam.h.

◆ GetRect()

MxRect32 & MxVideoParam::GetRect ( )

inline

[AI] Get the rectangle specifying the display dimensions and screen area.

Returns: Modifiable reference to the rectangle. [AI]

Definition at line 49 of file mxvideoparam.h.

◆ operator=()

MxVideoParam & MxVideoParam::operator= ( const MxVideoParam & p_videoParam )

[AI] Assignment operator, performs deep copy (including device name string) of another instance.

Parameters

p_videoParam Source object to copy from. [AI]

Returns: Reference to this object after assignment. [AI]

Definition at line 77 of file mxvideoparam.cpp.

◆ SetBackBuffers()

void MxVideoParam::SetBackBuffers ( MxU32 p_backBuffers )

inline

[AI] Set the desired number of backbuffers (triple/double buffering).

Parameters

p_backBuffers Desired backbuffer count. [AI]

Definition at line 68 of file mxvideoparam.h.

◆ SetDeviceName()

void MxVideoParam::SetDeviceName ( char * p_deviceId )

[AI] Set the device name/id for this video parameter (e.g., a specific display adapter), making a deep copy of the input string.

Parameters

p_deviceId Null-terminated string with device identifier; if NULL device will be unset. [AI]

Definition at line 57 of file mxvideoparam.cpp.

◆ SetPalette()

void MxVideoParam::SetPalette ( MxPalette * p_palette )

inline

[AI] Assign the palette pointer (color indexing) for the video mode.

Parameters

p_palette Palette instance to assign. [AI]

Definition at line 57 of file mxvideoparam.h.

Member Data Documentation

◆ p_backBuffers

MxPalette MxULong MxVideoParam::p_backBuffers

Definition at line 25 of file mxvideoparam.h.

◆ p_flags

MxPalette MxULong MxVideoParamFlags& MxVideoParam::p_flags

Definition at line 25 of file mxvideoparam.h.

◆ p_palette

MxPalette* MxVideoParam::p_palette

Definition at line 25 of file mxvideoparam.h.

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MxVideoParam() [1/2]

◆ MxVideoParam() [2/2]

◆ ~MxVideoParam()

Member Function Documentation

◆ __declspec()

◆ Flags()

◆ GetBackBuffers()

◆ GetDeviceName()

◆ GetPalette()

◆ GetRect()

◆ operator=()

◆ SetBackBuffers()

◆ SetDeviceName()

◆ SetPalette()

Member Data Documentation

◆ p_backBuffers

◆ p_flags

◆ p_palette