FreeSpace Wiki - User contributions [en]

Category:3d Graphics

2006-02-13T09:41:50Z

Rousseau:

[[Category:Source Code]]

Source Code Reference

2006-02-13T09:40:42Z

Rousseau: /* Freespace2 Code Base */

==CVS Directory Structure==
The fs2_open CVS consists of several major components, each of which is kept in a separate directory:

* Freespace2 Code base (code)

Plus the following libraries:
* LUA Scripting language (lua)
* Jpeg library (libjpeg)
* Ogg Vorbis sound library (oggvorbis)
* DirectX 8 SDK (dx8sdk)
* DirectX 9 SDK (dx9sdk)

===Libraries===
See msdn.microsoft.com for discussion of the DirectX libraries. For the other libraries, look in the README files for more info.

===Freespace2 Code Base===
The main code consists of several subdirectories:

* ai (Computer AI)
* [[Source anim|anim]] (Displaying .ani animated bitmaps)
* asteroid (Handle asteroids - movement, collisions, creating smaller asteriods when larger ones are blown up etc.)
* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)
* [[Source bmpman|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)
* camera (???)
* cfile (File/directory management routines including .VP file handling that are OS independent eg. handles differences between Linux & Windows)
* cmdline (Handles command line switches, such as -mipmap etc.)
* cmeasure (Handles countermeasures - flares that the player & AI can drop to disrupt missiles)
* controlconfig (Configures keyboard/mouse/joystick controls)
* cutscene (Handles cutscene viewing)
* [[Source ddsutils|ddsutils]] (Handles compressed textures for 3d graphics cards that support it)
* debris (Creates & handles flying debris from exploding ships)
* debugconsole (Handles debugging console and file)
* decals (Adds support for painting decals - small 2d textures - onto ships etc.)
* demo (Allows you to save & playback games to show as demos)
* directx (Specific includes for the Microsoft DirectX library - Windows only)
* exceptionhandler (Deals with crashes, saving stack trace, system info etc.)
* fireball (Displays & handles fireballs and warping effects)
* freespace2 (Main code - handles engine initialisation, loading resources, plus windows resources like icons & dialog boxes)
* fs2open_pxo (Network code)
* gamehelp (Displays context sensitive help text)
* gamesequence (Handles progression of events during a campaign, such as entering a mission, showing credits etc.)
* gamesnd (Handles sounds & music)
* globalincs (Basic global constants & definitions, eg. version, colours)
* [[Source graphics|graphics]] (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)
* hud (Handles the HUD - all the 2d cockpit graphics that the player can see eg. radar, ammo, escort list, sqaud etc)
* iff_defs (Handles traitor ships???)
* io (Handles IO devices, such as keyboard, mouse & joystick)
* irc (Adds support for an IRC chat client)
* [[Source jpgutils|jpgutils]] (Opens, reads JPG files)
* jumpnode (Displays & handles jump nodes)
* lab (???)
* lighting (Handles light sources, and their effect on ships)
* localization (Handles a global string table for translating all written text into foreign languages)
* math (Library of math routines for handling vectors, splines etc)
* menuui (Handles all the misc user interface, such as the main menu, tech room, campaign list etc)
* mission (Handles general mission actions eg. briefing, goals, training info, in-mission messages etc)
* missionui (Handles UI for general mission actions)
* mm (Headers for older MS Multimedia library)
* model (Displays and handles ship models eg. reading files, collission detection etc)
* nebula (Displays and handles nebulae)
* network (All multi-player code, eg. UI, network traffic)
* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)
* observer (???)
* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)
* palman (Handles bitmap palettes - different colour maps for the same 2d bitmap)
* parse (Handles scripting files, eg. python, LUA etc)
* particle (Displays and handles particles, such as smoke, fire)
* [[Source pcxutils|pcxutils]] (Handles 2d .pcx graphics files)
* physics (Handles realistic physical behaviour of objects, such as ship acceleration/deceleration, rotation etc.)
* playerman (Handles pilot files & player ship movement)
* popup (Displays & handles 2d pop-up windows, eg. when the player dies)
* radar (Displays & handles the radar)
* [[Source render|render]] (Low-level 3d rendering code for some primitives)
* ship (Displays & handles all ship code, eg. shields, afterburner)
* sound (Low-level sound, speach & music routines)
* species_defs (Reads species_defs.tbl to handle different behaviour for different species)
* starfield (Displays & handles background images such as starfields, nebulae etc)
* stats (Displays & handles player statistics, medals etc)
* [[Source tgautils|tgautils]] (Handles .tga 2d graphics files)
* ui (Low-level user inteface routines eg. buttons, scrollbars)
* vcodec (Handles player voice streaming for multiplayer ???)
* weapon (Displays & handles everything to do with weapons)
* windows_stub (Low-level windows functions that are needed for Unix)

There are also some directories that are only used for generating tools (not part of the main fs2 executable):
* cfilearchiver (Creates .VP file archives)
* cfileextractor (Extracts .VP file archives)
* cryptstring (Creates encrypted strings)
* fred2 (The FReespace EDitor)
* inetfile (FTP & HTTP network handlers)
* scramble (Utility to scramble file tables for the Demo version)
* variables (???)
* wxfred2 (Cross-platform version of FRED2)

==Category Browser==
The subdirectories above are also categorised by function. See the Category:Source Code to browse this way.

[[Category:Source Code]]

Source graphics

2006-02-13T09:38:39Z

Rousseau:

==Summary==
Contains both high-level and low-level routines for handling 3d graphics primitives. To allow for rendering with either DirectX or OpenGL, the graphics engine uses a structure (gr_screen) with function pointers to all the standard 3d operations (such as initialising the screen, page flipping, displaying primitives etc.). There are basically two sets of source files: grd3d* (DirectX) and gropengl* (OpenGL).

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 3 |gr_screen/screen global struct
| res, mode, aspect etc.
| Contains all info about screen setup (bits, resolution, etc)
|-
| gf_* functions
| Wraps standard 3d functions such as page flip, render buffer etc. allowing the engine to abstract DirectX and OpenGL functions.
|-
| gf_render_buffer()
| Main rendering call for models (ships etc.). Wraps buffer rendering modes in DirectX/OpenGL.
|-
| gr_* functions
| gr_init()
| Initialises graphics engine (either DirectX or OpenGL)
|}

[[Category:3d Graphics]]

Source render

2006-02-13T08:35:48Z

Rousseau:

==Summary==
Contains low-level routines for handling 3d graphics primitives. Called from graphics, ui code etc.

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 4 | g3_* functions
| g3_start_frame() / g3_start_frame_func()
| Starts the render frame.
|-
| g3_draw_poly()
| Draws a textured polygon. Called from graphics, model and object code (eg. nebula, warp points, weapons etc.)
|-
| g3_draw_line()
| Draws a line in 3d. Used to show grids etc.
|-
| g3_draw_bitmap()
| Draws a 2d bitmap at a point 3d. Used for particle effects etc.
|}

[[Category:3d Graphics]]

Source Code Reference

2006-02-13T08:02:55Z

Rousseau: /* Freespace2 Code Base */

==CVS Directory Structure==
The fs2_open CVS consists of several major components, each of which is kept in a separate directory:

* Freespace2 Code base (code)

Plus the following libraries:
* LUA Scripting language (lua)
* Jpeg library (libjpeg)
* Ogg Vorbis sound library (oggvorbis)
* DirectX 8 SDK (dx8sdk)
* DirectX 9 SDK (dx9sdk)

===Libraries===
See msdn.microsoft.com for discussion of the DirectX libraries. For the other libraries, look in the README files for more info.

===Freespace2 Code Base===
The main code consists of several subdirectories:

* ai (Computer AI)
* [[Source anim|anim]] (Displaying .ani animated bitmaps)
* asteroid (Handle asteroids - movement, collisions, creating smaller asteriods when larger ones are blown up etc.)
* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)
* [[Source bmpman|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)
* camera (???)
* cfile (File/directory management routines including .VP file handling that are OS independent eg. handles differences between Linux & Windows)
* cmdline (Handles command line switches, such as -mipmap etc.)
* cmeasure (Handles countermeasures - flares that the player & AI can drop to disrupt missiles)
* controlconfig (Configures keyboard/mouse/joystick controls)
* cutscene (Handles cutscene viewing)
* [[Source ddsutils|ddsutils]] (Handles compressed textures for 3d graphics cards that support it)
* debris (Creates & handles flying debris from exploding ships)
* debugconsole (Handles debugging console and file)
* decals (Adds support for painting decals - small 2d textures - onto ships etc.)
* demo (Allows you to save & playback games to show as demos)
* directx (Specific includes for the Microsoft DirectX library - Windows only)
* exceptionhandler (Deals with crashes, saving stack trace, system info etc.)
* fireball (Displays & handles fireballs and warping effects)
* freespace2 (Main code - handles engine initialisation, loading resources, plus windows resources like icons & dialog boxes)
* fs2open_pxo (Network code)
* gamehelp (Displays context sensitive help text)
* gamesequence (Handles progression of events during a campaign, such as entering a mission, showing credits etc.)
* gamesnd (Handles sounds & music)
* globalincs (Basic global constants & definitions, eg. version, colours)
* graphics (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)
* hud (Handles the HUD - all the 2d cockpit graphics that the player can see eg. radar, ammo, escort list, sqaud etc)
* iff_defs (Handles traitor ships???)
* io (Handles IO devices, such as keyboard, mouse & joystick)
* irc (Adds support for an IRC chat client)
* [[Source jpgutils|jpgutils]] (Opens, reads JPG files)
* jumpnode (Displays & handles jump nodes)
* lab (???)
* lighting (Handles light sources, and their effect on ships)
* localization (Handles a global string table for translating all written text into foreign languages)
* math (Library of math routines for handling vectors, splines etc)
* menuui (Handles all the misc user interface, such as the main menu, tech room, campaign list etc)
* mission (Handles general mission actions eg. briefing, goals, training info, in-mission messages etc)
* missionui (Handles UI for general mission actions)
* mm (Headers for older MS Multimedia library)
* model (Displays and handles ship models eg. reading files, collission detection etc)
* nebula (Displays and handles nebulae)
* network (All multi-player code, eg. UI, network traffic)
* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)
* observer (???)
* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)
* palman (Handles bitmap palettes - different colour maps for the same 2d bitmap)
* parse (Handles scripting files, eg. python, LUA etc)
* particle (Displays and handles particles, such as smoke, fire)
* [[Source pcxutils|pcxutils]] (Handles 2d .pcx graphics files)
* physics (Handles realistic physical behaviour of objects, such as ship acceleration/deceleration, rotation etc.)
* playerman (Handles pilot files & player ship movement)
* popup (Displays & handles 2d pop-up windows, eg. when the player dies)
* radar (Displays & handles the radar)
* render (High-level 3d rendering code)
* ship (Displays & handles all ship code, eg. shields, afterburner)
* sound (Low-level sound, speach & music routines)
* species_defs (Reads species_defs.tbl to handle different behaviour for different species)
* starfield (Displays & handles background images such as starfields, nebulae etc)
* stats (Displays & handles player statistics, medals etc)
* [[Source tgautils|tgautils]] (Handles .tga 2d graphics files)
* ui (Low-level user inteface routines eg. buttons, scrollbars)
* vcodec (Handles player voice streaming for multiplayer ???)
* weapon (Displays & handles everything to do with weapons)
* windows_stub (Low-level windows functions that are needed for Unix)

There are also some directories that are only used for generating tools (not part of the main fs2 executable):
* cfilearchiver (Creates .VP file archives)
* cfileextractor (Extracts .VP file archives)
* cryptstring (Creates encrypted strings)
* fred2 (The FReespace EDitor)
* inetfile (FTP & HTTP network handlers)
* scramble (Utility to scramble file tables for the Demo version)
* variables (???)
* wxfred2 (Cross-platform version of FRED2)

==Category Browser==
The subdirectories above are also categorised by function. See the Category:Source Code to browse this way.

[[Category:Source Code]]

Source pcxutils

2006-02-13T07:53:23Z

Rousseau:

==Summary==
Contains low-level routines for loading .pcx 2d graphics files.

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 2 | pcx_* functions
| pcx_read_bitmap*()
| Various funcitons to read the bitmap contents from different format .pcx files (8 bit, 16 bit etc.).
|-
| pcx_read_header()
| Reads the header from a .pcx file
|}

[[Category:2d Graphics]]

Source Code Reference

2006-02-13T07:46:36Z

Rousseau: /* Freespace2 Code Base */

==CVS Directory Structure==
The fs2_open CVS consists of several major components, each of which is kept in a separate directory:

* Freespace2 Code base (code)

Plus the following libraries:
* LUA Scripting language (lua)
* Jpeg library (libjpeg)
* Ogg Vorbis sound library (oggvorbis)
* DirectX 8 SDK (dx8sdk)
* DirectX 9 SDK (dx9sdk)

===Libraries===
See msdn.microsoft.com for discussion of the DirectX libraries. For the other libraries, look in the README files for more info.

===Freespace2 Code Base===
The main code consists of several subdirectories:

* ai (Computer AI)
* [[Source anim|anim]] (Displaying .ani animated bitmaps)
* asteroid (Handle asteroids - movement, collisions, creating smaller asteriods when larger ones are blown up etc.)
* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)
* [[Source bmpman|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)
* camera (???)
* cfile (File/directory management routines including .VP file handling that are OS independent eg. handles differences between Linux & Windows)
* cmdline (Handles command line switches, such as -mipmap etc.)
* cmeasure (Handles countermeasures - flares that the player & AI can drop to disrupt missiles)
* controlconfig (Configures keyboard/mouse/joystick controls)
* cutscene (Handles cutscene viewing)
* [[Source ddsutils|ddsutils]] (Handles compressed textures for 3d graphics cards that support it)
* debris (Creates & handles flying debris from exploding ships)
* debugconsole (Handles debugging console and file)
* decals (Adds support for painting decals - small 2d textures - onto ships etc.)
* demo (Allows you to save & playback games to show as demos)
* directx (Specific includes for the Microsoft DirectX library - Windows only)
* exceptionhandler (Deals with crashes, saving stack trace, system info etc.)
* fireball (Displays & handles fireballs and warping effects)
* freespace2 (Main code - handles engine initialisation, loading resources, plus windows resources like icons & dialog boxes)
* fs2open_pxo (Network code)
* gamehelp (Displays context sensitive help text)
* gamesequence (Handles progression of events during a campaign, such as entering a mission, showing credits etc.)
* gamesnd (Handles sounds & music)
* globalincs (Basic global constants & definitions, eg. version, colours)
* graphics (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)
* hud (Handles the HUD - all the 2d cockpit graphics that the player can see eg. radar, ammo, escort list, sqaud etc)
* iff_defs (Handles traitor ships???)
* io (Handles IO devices, such as keyboard, mouse & joystick)
* irc (Adds support for an IRC chat client)
* [[Source jpgutils|jpgutils]] (Opens, reads JPG files)
* jumpnode (Displays & handles jump nodes)
* lab (???)
* lighting (Handles light sources, and their effect on ships)
* localization (Handles a global string table for translating all written text into foreign languages)
* math (Library of math routines for handling vectors, splines etc)
* menuui (Handles all the misc user interface, such as the main menu, tech room, campaign list etc)
* mission (Handles general mission actions eg. briefing, goals, training info, in-mission messages etc)
* missionui (Handles UI for general mission actions)
* mm (Headers for older MS Multimedia library)
* model (Displays and handles ship models eg. reading files, collission detection etc)
* nebula (Displays and handles nebulae)
* network (All multi-player code, eg. UI, network traffic)
* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)
* observer (???)
* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)
* palman (Handles bitmap palettes - different colour maps for the same 2d bitmap)
* parse (Handles scripting files, eg. python, LUA etc)
* particle (Displays and handles particles, such as smoke, fire)
* pcxutils (Handles 2d .pcx graphics files)
* physics (Handles realistic physical behaviour of objects, such as ship acceleration/deceleration, rotation etc.)
* playerman (Handles pilot files & player ship movement)
* popup (Displays & handles 2d pop-up windows, eg. when the player dies)
* radar (Displays & handles the radar)
* render (High-level 3d rendering code)
* ship (Displays & handles all ship code, eg. shields, afterburner)
* sound (Low-level sound, speach & music routines)
* species_defs (Reads species_defs.tbl to handle different behaviour for different species)
* starfield (Displays & handles background images such as starfields, nebulae etc)
* stats (Displays & handles player statistics, medals etc)
* [[Source tgautils|tgautils]] (Handles .tga 2d graphics files)
* ui (Low-level user inteface routines eg. buttons, scrollbars)
* vcodec (Handles player voice streaming for multiplayer ???)
* weapon (Displays & handles everything to do with weapons)
* windows_stub (Low-level windows functions that are needed for Unix)

There are also some directories that are only used for generating tools (not part of the main fs2 executable):
* cfilearchiver (Creates .VP file archives)
* cfileextractor (Extracts .VP file archives)
* cryptstring (Creates encrypted strings)
* fred2 (The FReespace EDitor)
* inetfile (FTP & HTTP network handlers)
* scramble (Utility to scramble file tables for the Demo version)
* variables (???)
* wxfred2 (Cross-platform version of FRED2)

==Category Browser==
The subdirectories above are also categorised by function. See the Category:Source Code to browse this way.

[[Category:Source Code]]

Category:Source Code

2006-02-13T07:46:01Z

Rousseau:

Below is a list of different categories of functionality and where to find them.

Category:2d Graphics

2006-02-13T07:45:07Z

Rousseau:

Below are references to parts of the source code that deal with loading and display of 2d graphics.

[[Category:Source Code]]

Category:2d Graphics

2006-02-13T07:42:51Z

Rousseau:

Below are references to parts of the source code that deal with loading and display of 2d graphics.

[[Category:Source Code Categories]]

Source tgautils

2006-02-13T07:40:47Z

Rousseau:

==Summary==
Contains low-level routines for loading .tga 2d graphics files.

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 2 | targa_* functions
| targa_read_bitmap()
| Called from bmpman to read the bitmap contents from a .tga file.
|-
| targa_read_header()
| Called from bmpman to read the header from a .tga file
|}

[[Category:2d Graphics]]

Category:2d Graphics

2006-02-13T07:37:10Z

Rousseau:

Below are references to parts of the source code that deal with loading and display of 2d graphics.

Source jpgutils

2006-02-13T07:32:06Z

Rousseau:

==Summary==
Contains low-level routines for loading .jpg 2d graphics files.

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 2 | jpeg_* functions
| jpeg_read_bitmap()
| Reads the bitmap contents from a .jpg file.
|-
| jpeg_read_header()
| Reads the header from a .jpg file
|}

[[Category:2d Graphics]]

Source ddsutils

2006-02-13T07:29:43Z

Rousseau:

==Summary==
Contains low-level routines for loading .dds 2d graphics files.

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 2 | dds_* functions
| dds_read_bitmap()
| Called from bmpman to read the bitmap contents from a .dds file.
|-
| dds_read_header()
| Called from bmpman to read the header from a .dds file
|}

[[Category:2d Graphics]]

Source anim

2006-02-13T07:24:04Z

Rousseau:

==Summary==
Contains high-level routines for loading & playing 2d .ani animation files.

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 2 | anim_* functions
| anim_load()
| Loads a .ani file
|-
| anim_play()
| Plays an animation file. Used in the main hall UI, mission briefing etc.
|}

[[Category:2d Graphics]]

Source bmpman

2006-02-13T06:51:59Z

Rousseau: Basic info

==Summary==
Contains high-level routines for loading & manipulating 2d graphics files, in .tga, .jpg, .dds, or .pcx format.

==Major Classes/Functions/Structs==
{| border="1" cellspacing="0" cellpadding="4"
|-
! Class/Group/Struct
! Method/Function/Element
! Notes
|-
| rowspan = 2 | bm_* functions
| bm_load()
| Loads a graphic from a file. Used all over the place (UI, effects etc)
|-
| bm_create()
| Allocates memory space for a bitmap (eg. for animations, or where a graphic is created in memory rather than loaded).
|}

[[Category:2d Graphics]]