Startup Interface

Describes everything about the startup of the Renderer and the Resources. Setups the display mode and controls display mode shifts and loss of window focus. Some functionality is in the main Source1.cpp, however most logic is in this interface.

Summary

Startup Interface	Describes everything about the startup of the Renderer and the Resources.
startup.cpp
Enumerations
MODE_TYP	Specifies what mode the program is running in
STATE_TYP	Describes the current running mode.
Macros
RGB10BIT_STRING	Used to force the compiler to write out the words RGB10BIT
Types
SETTINGS	Alias for SETTINGS_TYP
SETTINGS_PTR	Alias for a pointer to SETTINGS_TYP
SETTINGS_TYP	This structure is more or less obsolete.
Variables
Width	UINT The width of the display surface
Height	UINT The height of the display surface
IsWindowed	UINT Specifies whether the program is windowed or not
IsActive	UINT Specifies wether the program is still active or not
BackBufferFormat	UINT Specifies the exact type of the back buffer for D3D objects to know
IsLogWindow	UINT Specifies wether a log window exists or not
IsDebugWindow	UINT Specifies wether a debug control panel window exists or not
dwD3DInitMode	DWORD Some options for the D3DInterface to use.
VSync	UINT Determines wether VSync should be attempted or not
bpp	UINT The Bits per Pixel of the display
hz	UINT The Hertz the screen updates at.
Mode	MODE_TYP The rendering mode requested
hwndMain	HWND The main window
CStartup	Interface to control and query the running state of the program.
Constructors
CStartup	Simply increases the internal reference count
~CStartup	Simply decreases the internal reference count
Functions
ShowStartupDialog	Show the main startup dialog and save the results into the class.
InitDevices	Initializes devices for the desired running mode.
Shutdown	Shutdown all the interfaces.
TestState	Tests the state of the devices for any changes.
ProcessState	Processes the current state of the interface.
TriggerTestState	If possible, puts the interface into STATE_TEST.
DisplayModeShift	Puts the startup into a state to change the display mode from Fullscreen or Windowed.
ResizeWindow	Resizes the back buffer to match a resized window.
Access Functions
getState	Retrieves the state of the interface
getMode	The current MODE_TYP
getWidth	The current width of the window or back buffer
getHeight	The current height of the window or back buffer
getFSWidth	The stored fullscreen width of the backbuffer
getFSHeight	The stored fullscreen height of the backbuffer
getBpp	The bits per pixel for the current display mode.
getHz	The current HZ the monitor is sync at.
getBackBufferFormat	Specifies the exact type of the pixel format of the back buffer.
getVSync	True if the display refresh rate is in sync with the monitor.

startup.cpp

DFLT_SCREEN_WIDTH	Defaults to 800. Determines the highlighted screen size in the startup dialog
DFLT_SCREEN_HEIGHT	Defaults to 600. Determines the highlighted screen size in the startup dialog
RGB10BIT	Defaults to 40. Used to identify a 10bit per channel RGB BitsPerPixel.
STARTUP_EXIT	Defaults to 100. This is the return value when EXIT is pressed in the Startup dialog

Enumerations

MODE_TYP

Specifies what mode the program is running in

MODE_NONE	Uninitialized and not ready for startup
MODE_D3D	Initialized in Direct3D Mode
MODE_DDRAW	Initialized in DirectDraw Mode
MODE_GDI	Initialized in GDI Mode

STATE_TYP

Describes the current running mode. This is used in a finite state routine in the main program to keep the running mode valid and respond to changing in the environment.

STATE_SHUTDOWN	Signals that the program is shutting down
STATE_ERROR	Startup assumed all was well, but interfaces are not ready for unknown reasons
STATE_CLEAN	Nothing initialized or setup. Can start in any mode at this point
STATE_DISPLAY_REINIT_TOTAL	Reinitialization requested for a total reset
STATE_DISPLAY_REINIT_WINDOWED	Reinitialization requested for a display mode shift to Windowed mode
STATE_DISPLAY_REINIT_FULLSCREEN	Reinitialization requested for a display mode shift to Fullscreen mode
STATE_DISPLAY_REINIT_RESIZE	Reinitialization requested for a resize in the window
STATE_DISPLAY_REINIT_PENDING	Display and Resources must be re initialized and can be at any time
STATE_DISPLAY_INIT_OK	Display is initialized and ok
STATE_RESOURCES_INIT_OK	Resource class is initialized with the mode and is ok
STATE_RENDERER_INIT_OK	Renderer initialization completed
STATE_WAIT	Display and Resources must be re initialized, but unable to yet
STATE_TEST	Request for testing the interfaces for ready status
STATE_RUN	Startup is in run mode and all is ready to go

Macros

RGB10BIT_STRING

Used to force the compiler to write out the words RGB10BIT

#define RGB10BIT_STRING     STRINGIZE(RGB10BIT)

Types

SETTINGS

Alias for SETTINGS_TYP

SETTINGS_PTR

Alias for a pointer to SETTINGS_TYP

SETTINGS_TYP

typedef struct SETTINGS_TYP

This structure is more or less obsolete. It has not been removed out of the initial startup procedures. All of the functions have been moved into CStartup. CStartup uses this structure to setup defaults.

Summary

Variables
Width	UINT The width of the display surface
Height	UINT The height of the display surface
IsWindowed	UINT Specifies whether the program is windowed or not
IsActive	UINT Specifies wether the program is still active or not
BackBufferFormat	UINT Specifies the exact type of the back buffer for D3D objects to know
IsLogWindow	UINT Specifies wether a log window exists or not
IsDebugWindow	UINT Specifies wether a debug control panel window exists or not
dwD3DInitMode	DWORD Some options for the D3DInterface to use.
VSync	UINT Determines wether VSync should be attempted or not
bpp	UINT The Bits per Pixel of the display
hz	UINT The Hertz the screen updates at.
Mode	MODE_TYP The rendering mode requested
hwndMain	HWND The main window

Variables

Width

UINT Width

UINT The width of the display surface

Height

UINT Height

UINT The height of the display surface

IsWindowed

UINT IsWindowed

UINT Specifies whether the program is windowed or not

IsActive

UINT IsActive

UINT Specifies wether the program is still active or not

BackBufferFormat

UINT BackBufferFormat

UINT Specifies the exact type of the back buffer for D3D objects to know

IsLogWindow

UINT IsLogWindow

UINT Specifies wether a log window exists or not

IsDebugWindow

UINT IsDebugWindow

UINT Specifies wether a debug control panel window exists or not

dwD3DInitMode

DWORD dwD3DInitMode

DWORD Some options for the D3DInterface to use.

VSync

UINT VSync

UINT Determines wether VSync should be attempted or not

bpp

UINT bpp

UINT The Bits per Pixel of the display

hz

UINT hz

UINT The Hertz the screen updates at. May not be able to determine

Mode

MODE_TYP Mode

MODE_TYP The rendering mode requested

hwndMain

HWND hwndMain

HWND The main window

CStartup

class CStartup

Interface to control and query the running state of the program. Contains all information from the options dialog and allows the display to respond to windows environment changes.

The follow code controls the state.  This should be in your main program.

STATE_TYP   StartupState;

switch( StartupState = Startup.getState() )
{
case STATE_RUN:
    break;
case STATE_WAIT:
case STATE_TEST:
    // Validate the running state
    if( ( StartupState = Startup.TestState() ) != STATE_RUN )
    {
        if(bMainGate)
            LOG_INFO("Closing main gate because of state change");

        bMainGate=false;
    } else
    {
        if(!bMainGate)
            LOG_INFO("Opening main gate because of successful state change");

        bMainGate=true;
    }
    break;
case STATE_ERROR:
case STATE_SHUTDOWN:
    break;
default:
    // Let startup process the problem
    if( ( StartupState = Startup.ProcessState() ) == STATE_RUN )
    {
        if(!bMainGate)
            LOG_INFO("Opening main gate because of successful state change");

        bMainGate=true;
    }

    break;
}

Summary

Constructors
CStartup	Simply increases the internal reference count
~CStartup	Simply decreases the internal reference count
Functions
ShowStartupDialog	Show the main startup dialog and save the results into the class.
InitDevices	Initializes devices for the desired running mode.
Shutdown	Shutdown all the interfaces.
TestState	Tests the state of the devices for any changes.
ProcessState	Processes the current state of the interface.
TriggerTestState	If possible, puts the interface into STATE_TEST.
DisplayModeShift	Puts the startup into a state to change the display mode from Fullscreen or Windowed.
ResizeWindow	Resizes the back buffer to match a resized window.
Access Functions
getState	Retrieves the state of the interface
getMode	The current MODE_TYP
getWidth	The current width of the window or back buffer
getHeight	The current height of the window or back buffer
getFSWidth	The stored fullscreen width of the backbuffer
getFSHeight	The stored fullscreen height of the backbuffer
getBpp	The bits per pixel for the current display mode.
getHz	The current HZ the monitor is sync at.
getBackBufferFormat	Specifies the exact type of the pixel format of the back buffer.
getVSync	True if the display refresh rate is in sync with the monitor.

Constructors

CStartup

CStartup()

Simply increases the internal reference count

~CStartup

~CStartup()

Simply decreases the internal reference count

Functions

ShowStartupDialog

int ShowStartupDialog( HINSTANCE hinstance )

Show the main startup dialog and save the results into the class.

Parameters

hinstance

HINSTANCE the application instance to attach the window to

Returns

False if successful. Error code otherwise.

InitDevices

int InitDevices()

Initializes devices for the desired running mode. Handles the initalization of both the Renderer and the Resource Interfaces. It will catch exceptions thrown by the D3DInterface, DDrawInterface and the GDIInterface.

Returns

False if successful. Error code otherwise.

Shutdown

static void Shutdown()

Shutdown all the interfaces. Calls D3DInterface::ShutdownDevice, DDrawInterface::ShutdownInterface, GDIInterface::Shutdown, RSRC::Shutdown, and <RNDR::Shutdown>. Puts the class into mode STATE_SHUTDOWN.

TestState

STATE_TYP TestState()

Tests the state of the devices for any changes. If the STATE_TYP of the class is smaller than STATE_TEST it simply returns the state for later processing. Otherwise it changes the STATE_TYP to STATE_DISPLAY_REINIT_PENDING.

Returns

STATE_TYP Is the current state of the Startup Interface.

ProcessState

STATE_TYP ProcessState()

Processes the current state of the interface. It will run any required procedures to put the state back into STATE_RUN. However it may place the mode into a different mode, even STATE_ERROR depending on the needs.

Returns

STATE_TYP with the current mode after processing.

TriggerTestState

static STATE_TYP TriggerTestState()

If possible, puts the interface into STATE_TEST. If the STATE_TYP is already in a state below STATE_TEST, then it simple returns it.

Returns

STATE_TYP with the current mode after atempting to set STATE_TEST.

DisplayModeShift

STATE_TYP DisplayModeShift( HWND LogWindow )

Puts the startup into a state to change the display mode from Fullscreen or Windowed. Also handles hiding and showing the log window if one exists.

Parameters

LogWindow

The log window that should be hidden or shown, depending on options

Returns

STATE_TYP of the current state of the startup interface.

ResizeWindow

static STATE_TYP ResizeWindow( int width,
int height )

Resizes the back buffer to match a resized window. Puts the interface into a STATE_DISPLAY_REINIT_RESIZE.

Parameters

width	The new width of the window
height	The new height of the window

Returns

STATE_TYP of the current state of the interface.

Access Functions

getState

static STATE_TYP getState()

Retrieves the state of the interface

Returns

STATE_TYP with current state of the interface

getMode

MODE_TYP getMode() const

The current MODE_TYP

Returns

MODE_TYP of the interface

getWidth

UINT getWidth() const

The current width of the window or back buffer

Returns

UINT with the width

getHeight

UINT getHeight() const

The current height of the window or back buffer

Returns

UINT with the height

getFSWidth

UINT getFSWidth() const

The stored fullscreen width of the backbuffer

Returns

UINT with the width

getFSHeight

UINT getFSHeight() const

The stored fullscreen height of the backbuffer

Returns

UINT with the height

getBpp

UINT getBpp() const // Stores the bits per pixel

The bits per pixel for the current display mode. Could be 15,16,32, or RGB10BIT.

Returns

UINT with the bpp of the pixel format

getHz

UINT getHz() const // The hz the screen updates at

The current HZ the monitor is sync at. May be zero if unable to determine

Returns

UINT with the Hz of the monitor

getBackBufferFormat

UINT getBackBufferFormat() const // Specifies the exact type of the back buffer

Specifies the exact type of the pixel format of the back buffer. Specific to D3D types.

Returns

UINT with the D3DFORMAT.

getVSync

UINT getVSync() const // May not even be an option, but will include anyway

True if the display refresh rate is in sync with the monitor. Vertical Sync.

Returns

UINT True if on, false if not