Class hierarchy Compound list File list Compound Members File Members

# Screen Class Reference

This is an abstract class representing the 2D Screen. More...

Inherits Drawable.

List of all members.

## Public Members

- virtual long flip () = 0
    Flips the pages at the end of rendering.

- virtual int isModeAvailable (int Width, int Height) = 0
    Check if a display mode is available Returns a non-zero value if the mode is available.

- virtual int getFreeVideoMemory () = 0
    Returns the available video memory for bitmaps.

- virtual PixelFormat getPixelFormat () = 0
    Returns the pixel format of the display.

- virtual long getGammaControl (GammaControl& gc) = 0
    Retrieve the gamma control settings for the screen.

- virtual long setGammaControl (GammaControl& gc) = 0
    Set the gamma control settings for the screen.

- virtual long setGammaFade (float Red, float Green, float Blue) = 0
    Uses setGammaControl to set a linear fade setting.

- virtual void* getDDrawPrimarySurface () = 0
    Return the primary surface for creating special effects.

## Related Functions

(Note that these are not member functions.)

- DLLExport Screen* newWindowScreen (void* hWnd_, int Width, int Height, int NoAccel=0)
    Used to create a screen for console (non graphic) apps batch processing.

## Detailed Description

This is an abstract class representing the 2D Screen.

One of the subclasses: FullScreen , WindowScreen should be created. Console automatically creates this object.

## Member Function Documentation

### virtual long Screen::flip() = 0`[pure virtual]`

Flips the pages at the end of rendering.

### virtual int Screen::isModeAvailable(int Width, int Height) = 0`[pure virtual]`

Check if a display mode is available Returns a non-zero value if the mode is available.

### virtual int Screen::getFreeVideoMemory() = 0`[pure virtual]`

Returns the available video memory for bitmaps.

### virtual PixelFormat Screen::getPixelFormat() = 0`[pure virtual]`

Returns the pixel format of the display.

### virtual long Screen::getGammaControl(GammaControl& gc) = 0`[pure virtual]`

Retrieve the gamma control settings for the screen.

Returns NOT_SUPPORTED if hardware doesn't support gamma control.

### virtual long Screen::setGammaControl(GammaControl& gc) = 0`[pure virtual]`

Set the gamma control settings for the screen.

Returns NOT_SUPPORTED if hardware doesn't support gamma control.

### virtual long Screen::setGammaFade(float Red, float Green, float Blue) = 0`[pure virtual]`

Uses setGammaControl to set a linear fade setting.

All three colors must be in range of 0 - 1

### virtual void* Screen::getDDrawPrimarySurface() = 0`[pure virtual]`

Return the primary surface for creating special effects.

Care must be taken to return the surface to its original state (locks) to prevent internal inconsistencies. Return type should be cast to: LPDIRECTDRAWSURFACE4

### DLLExport Screen* newWindowScreen(void* hWnd_, int Width, int Height, int NoAccel=0)

Used to create a screen for console (non graphic) apps batch processing.

For a usual graphics game, it shouldn't be used.

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

- CON_Misc.h