User:Monster Iestyn/Source Code Documentation/i_video.h

From SRB2 Wiki
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
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 The current rendering mode being used.
highcolor boolean
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 If true, high color modes are used; if false, use normal 8-bit color modes.

In the DOS version of SRB2 (now unsupported), highcolor is false unless the command line parameter -highcolor is supplied; in all other versions/interfaces this parameter does not exist and highcolor is always false.

allow_fullscreen boolean
  • android/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
 If true, the video system can do fullscreen.

Function prototypes

Function name Return type Params Defined in Description
I_StartupGraphics void none
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Initialize video mode, setup dynamic screen size variables, and allocate screens.
I_ShutdownGraphics void none
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Close the screen, restore previous video mode.
I_SetPalette void RGBA_t *palette
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Sets the screen palette to the contents of palette.
VID_NumModes INT32 none
  • android/i_video.c
  • djgppdos/vid_vesa.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Returns the number of video modes.
VID_GetModeForSize INT32 INT32 w – width,
INT32 h – height
  • android/i_video.c
  • djgppdos/vid_vesa.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Returns the video mode closest to w : h.
VID_SetMode INT32 INT32 modenum
  • android/i_video.c
  • djgppdos/vid_vesa.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Returns the current video mode.
VID_GetModeName const char * INT32 modenum
  • android/i_video.c
  • djgppdos/vid_vesa.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Returns the name of the video mode.
VID_PrepareModeList void none
  • android/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
 Prepares video mode list.
I_UpdateNoBlit void none
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Updates video system without updating frame.
I_FinishUpdate void none
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 Updates video system.
I_UpdateNoVsync void none
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
 Updates video system with V-Sync disabled.
I_WaitVBL void INT32 count
  • android/i_video.c
  • djgppdos/i_system.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_system.c
  • sdl12/i_system.c
  • win32/win_sys.c
  • win32ce/win_sys.c
 Waits for vertical retrace or pauses a bit.
I_ReadScreen void UINT8 *scr
  • android/i_video.c
  • djgppdos/i_video.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_video.c
  • sdl12/i_video.c
  • win32/win_vid.c
  • win32ce/win_vid.c
 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
  • android/i_video.c
  • djgppdos/i_system.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_system.c
  • sdl12/i_system.c
  • win32/win_sys.c
  • win32ce/win_sys.c
 Has no effect, unused.
I_EndRead void none
  • android/i_video.c
  • djgppdos/i_system.c
  • dummy/i_video.c
  • nds/i_video.c
  • sdl/i_system.c
  • sdl12/i_system.c
  • win32/win_sys.c
  • win32ce/win_sys.c
 Has no effect, unused.
Retrieved from "https://wiki.srb2.org/w/index.php?title=User:Monster_Iestyn/Source_Code_Documentation/i_video.h&oldid=101909"