User:Monster Iestyn/Source Code Documentation/i_video.h
Jump to navigation
Jump to search
This article or section is incomplete. It doesn't have all of the necessary core information on this topic. Please help the SRB2 Wiki by finishing this article. |
Online link | GitHub entry |
---|---|
File type | C header file |
#include guard | __I_VIDEO__
|
Includes
Typedefs
Name | Type | Description |
---|---|---|
rendermode_t
|
enum
|
Rendering modes. |
rendermode_t
Value | Name | Description |
---|---|---|
1 | render_soft
|
Software renderer |
2 | render_opengl
|
OpenGL renderer |
3 | render_none
|
None; used for dedicated servers |
Externs
Data name | Data type | Non-extern location(s) | Description |
---|---|---|---|
rendermode
|
rendermode_t
|
|
The current rendering mode being used. |
highcolor
|
boolean |
|
If true, high color modes are used; if false, use normal 8-bit color modes.
In the DOS version of SRB2 (now unsupported), |
allow_fullscreen
|
boolean |
|
If true, the video system can do fullscreen. |
Function prototypes
Function name | Return type | Params | Defined in | Description |
---|---|---|---|---|
I_StartupGraphics
|
void | none |
|
Initialize video mode, setup dynamic screen size variables, and allocate screens. |
I_ShutdownGraphics
|
void | none |
|
Close the screen, restore previous video mode. |
I_SetPalette
|
void | RGBA_t *palette
|
|
Sets the screen palette to the contents of palette .
|
VID_NumModes
|
INT32 | none |
|
Returns the number of video modes. |
VID_GetModeForSize
|
INT32 | INT32 w – width,INT32 h – height
|
|
Returns the video mode closest to w : h .
|
VID_SetMode
|
INT32 | INT32 modenum
|
|
Returns the current video mode. |
VID_GetModeName
|
const char *
|
INT32 modenum
|
|
Returns the name of the video mode. |
VID_PrepareModeList
|
void | none |
|
Prepares video mode list. |
I_UpdateNoBlit
|
void | none |
|
Updates video system without updating frame. |
I_FinishUpdate
|
void | none |
|
Updates video system. |
I_UpdateNoVsync
|
void | none |
|
Updates video system with V-Sync disabled. |
I_WaitVBL
|
void | INT32 count
|
|
Waits for vertical retrace or pauses a bit. |
I_ReadScreen
|
void | UINT8 *scr
|
|
If called in Software mode, copies the main display window screen to scr . Otherwise, the game will crash with an error message.
|
I_BeginRead
|
void | none |
|
Has no effect, unused. |
I_EndRead
|
void | none |
|
Has no effect, unused. |