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

From SRB2 Wiki
Jump to navigation Jump to search
Online link GitHub entry
File type C header file
#include guard __R_LOCAL__

The global header file for all rendering/drawing modules. This includes all the header files prefixed with r_, except for r_splats.h.

Includes

Externs

Data name Data type Non-extern location(s) Description
*firstseg drawseg_t r_bsp.c Temporary pointer to the first drawseg created in the current subsector being rendered through R_RenderBSPNode.

This is non-NULL only if the subsector has any "fake floor" (FOF or PolyObject) planes, so it can store:

  • the number of fake floor planes to be drawn (->numffloorplanes)
  • an array of pointers to the fake floor planes themselves (->ffloorplanes)
  • an array of front scales for each column (->frontscale)

firstseg will be set to NULL again for the next subsector rendered.

Function prototypes

Function name Return type Params Defined in Description
SplitScreen_OnChange void none r_main.c Changes settings based on the current value of splitscreen, usually called after splitscreen's value has been changed. This was formerly the function called when the now-removed "splitscreen" console variable's value was modified.