Isle
Loading...
Searching...
No Matches
MxVideoParamFlags Class Reference

[AI] Manages video parameter flags, providing an abstraction for various video settings such as fullscreen, buffer flipping, color depth, and view angle controls. More...

#include <mxvideoparamflags.h>

Public Member Functions

 MxVideoParamFlags ()
 [AI] Constructs an MxVideoParamFlags instance and sets default values as found in the original game. More...
 
void SetFullScreen (MxBool p_e)
 [AI] Enable or disable fullscreen mode. More...
 
void SetFlipSurfaces (MxBool p_e)
 [AI] Toggle the use of flip (page flipping) for surfaces. More...
 
void SetBackBuffers (MxBool p_e)
 [AI] Toggle the use of a back buffer (double-buffered rendering). More...
 
void SetF1bit3 (MxBool p_e)
 [AI] Set an additional primary flag; exact usage is unknown but may control a video mode detail. More...
 
void Set16Bit (MxBool p_e)
 [AI] Specify whether 16-bit color depth should be used for rendering. More...
 
void SetWideViewAngle (MxBool p_e)
 [AI] Enable or disable a wider field of view for 3D rendering. More...
 
void SetF1bit7 (MxBool p_e)
 [AI] Set an additional flag (purpose unknown; originally used by the engine for extension). More...
 
void SetF2bit0 (MxBool p_e)
 [AI] Set secondary flag 0 (often used for internal video logic). More...
 
void SetF2bit1 (MxBool p_e)
 [AI] Set secondary flag 1 (often used for internal video logic). More...
 
MxBool GetFullScreen ()
 [AI] Get whether fullscreen mode is enabled. More...
 
MxBool GetFlipSurfaces ()
 [AI] Get whether page flipping of surfaces is enabled. More...
 
MxBool GetBackBuffers ()
 [AI] Get whether back buffering (double buffering) is enabled. More...
 
MxBool GetF1bit3 ()
 [AI] Get the value of primary flag 3. More...
 
MxBool Get16Bit ()
 [AI] Get whether 16-bit rendering mode is selected. More...
 
MxBool GetWideViewAngle ()
 [AI] Get whether a wide view angle is enabled. More...
 
MxBool GetF2bit0 ()
 [AI] Get the value of secondary flag 0. More...
 
MxBool GetF2bit1 ()
 [AI] Get the value of secondary flag 1. More...
 

Detailed Description

[AI] Manages video parameter flags, providing an abstraction for various video settings such as fullscreen, buffer flipping, color depth, and view angle controls.

This class encapsulates bit field flags that are used by the LEGO Island engine to toggle and query low-level video settings.

The configuration controlled here is passed, for example, into the DirectX initialization process to control rendering modes at runtime.

Each group of flags is split into separate bit field instances to match the structure and packing requirements of the game.

[AI] The first field (m_flags1) stores primary drawing option flags like fullscreen, flip surfaces, buffer count, color depth, and view angle; the second field (m_flags2) stores additional flags (purpose for these specific bits may be defined by video device requirements and engine conventions).

Definition at line 19 of file mxvideoparamflags.h.

Constructor & Destructor Documentation

◆ MxVideoParamFlags()

MxVideoParamFlags::MxVideoParamFlags ( )

[AI] Constructs an MxVideoParamFlags instance and sets default values as found in the original game.

Definition at line 9 of file mxvideoparamflags.cpp.

Member Function Documentation

◆ Get16Bit()

MxBool MxVideoParamFlags::Get16Bit ( )
inline

[AI] Get whether 16-bit rendering mode is selected.

Returns
True if 16-bit mode is enabled. [AI]

Definition at line 109 of file mxvideoparamflags.h.

◆ GetBackBuffers()

MxBool MxVideoParamFlags::GetBackBuffers ( )
inline

[AI] Get whether back buffering (double buffering) is enabled.

Returns
True if back buffers are enabled. [AI]

Definition at line 97 of file mxvideoparamflags.h.

◆ GetF1bit3()

MxBool MxVideoParamFlags::GetF1bit3 ( )
inline

[AI] Get the value of primary flag 3.

The specific meaning is currently unknown.

Returns
Value of flag 3. [AI]

Definition at line 103 of file mxvideoparamflags.h.

◆ GetF2bit0()

MxBool MxVideoParamFlags::GetF2bit0 ( )
inline

[AI] Get the value of secondary flag 0.

Returns
Value of flag 0 in m_flags2. [AI]

Definition at line 121 of file mxvideoparamflags.h.

◆ GetF2bit1()

MxBool MxVideoParamFlags::GetF2bit1 ( )
inline

[AI] Get the value of secondary flag 1.

Returns
Value of flag 1 in m_flags2. [AI]

Definition at line 127 of file mxvideoparamflags.h.

◆ GetFlipSurfaces()

MxBool MxVideoParamFlags::GetFlipSurfaces ( )
inline

[AI] Get whether page flipping of surfaces is enabled.

Returns
True if flip surfaces is enabled. [AI]

Definition at line 91 of file mxvideoparamflags.h.

◆ GetFullScreen()

MxBool MxVideoParamFlags::GetFullScreen ( )
inline

[AI] Get whether fullscreen mode is enabled.

Returns
True if fullscreen mode is enabled. [AI]

Definition at line 85 of file mxvideoparamflags.h.

◆ GetWideViewAngle()

MxBool MxVideoParamFlags::GetWideViewAngle ( )
inline

[AI] Get whether a wide view angle is enabled.

Returns
True if wide view angle is enabled. [AI]

Definition at line 115 of file mxvideoparamflags.h.

◆ Set16Bit()

void MxVideoParamFlags::Set16Bit ( MxBool  p_e)
inline

[AI] Specify whether 16-bit color depth should be used for rendering.

Parameters
p_eTrue for 16-bit color; false for 8-bit or 32-bit depending on the rest of the configuration. [AI]

Definition at line 55 of file mxvideoparamflags.h.

◆ SetBackBuffers()

void MxVideoParamFlags::SetBackBuffers ( MxBool  p_e)
inline

[AI] Toggle the use of a back buffer (double-buffered rendering).

Parameters
p_eTrue for double buffering, false for single buffer. [AI]

Definition at line 43 of file mxvideoparamflags.h.

◆ SetF1bit3()

void MxVideoParamFlags::SetF1bit3 ( MxBool  p_e)
inline

[AI] Set an additional primary flag; exact usage is unknown but may control a video mode detail.

Parameters
p_eValue to assign to primary flag 3. [AI]

Definition at line 49 of file mxvideoparamflags.h.

◆ SetF1bit7()

void MxVideoParamFlags::SetF1bit7 ( MxBool  p_e)
inline

[AI] Set an additional flag (purpose unknown; originally used by the engine for extension).

Parameters
p_eValue to assign to primary flag 7. [AI]

Definition at line 67 of file mxvideoparamflags.h.

◆ SetF2bit0()

void MxVideoParamFlags::SetF2bit0 ( MxBool  p_e)
inline

[AI] Set secondary flag 0 (often used for internal video logic).

Parameters
p_eValue for the corresponding secondary flag. [AI]

Definition at line 73 of file mxvideoparamflags.h.

◆ SetF2bit1()

void MxVideoParamFlags::SetF2bit1 ( MxBool  p_e)
inline

[AI] Set secondary flag 1 (often used for internal video logic).

Parameters
p_eValue for the corresponding secondary flag. [AI]

Definition at line 79 of file mxvideoparamflags.h.

◆ SetFlipSurfaces()

void MxVideoParamFlags::SetFlipSurfaces ( MxBool  p_e)
inline

[AI] Toggle the use of flip (page flipping) for surfaces.

Parameters
p_eTrue to enable flipping, false to disable. [AI]

Definition at line 37 of file mxvideoparamflags.h.

◆ SetFullScreen()

void MxVideoParamFlags::SetFullScreen ( MxBool  p_e)
inline

[AI] Enable or disable fullscreen mode.

Parameters
p_eTrue to enable fullscreen, false for windowed. [AI]

Definition at line 31 of file mxvideoparamflags.h.

◆ SetWideViewAngle()

void MxVideoParamFlags::SetWideViewAngle ( MxBool  p_e)
inline

[AI] Enable or disable a wider field of view for 3D rendering.

Parameters
p_eTrue to use a wider field of view. [AI]

Definition at line 61 of file mxvideoparamflags.h.


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