Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.


Warning for game developers: PCGamingWiki staff members will only ever reach out to you using the official press@pcgamingwiki.com mail address.
Be aware of scammers claiming to be representatives or affiliates of PCGamingWiki who promise a PCGW page for a game key.

Difference between revisions of "Template:API/Documentation"

From PCGamingWiki, the wiki about fixing PC games
m (added 8.1 + notable features + bullet about how DirectX versions are mapped to their appropriate Direct3D counterpart)
m (added "true" as supported value for Vulkan + OpenGL and changes the structure a bit and fixed infobox link)
Line 3: Line 3:
  
 
;Supported values
 
;Supported values
 +
 +
''Direct3D versions''
 +
 
{| class="mw-collapsible mw-collapsed wikitable"
 
{| class="mw-collapsible mw-collapsed wikitable"
 
|-
 
|-
Line 48: Line 51:
 
|}
 
|}
 
{{ii}} The parameter will automatically map DirectX versions over to the appropriate Direct3D version (e.g. {{Code|8.2}} is mapped to {{Code|8.1}} as DirectX 8.2 did not bring a new version of Direct3D.
 
{{ii}} The parameter will automatically map DirectX versions over to the appropriate Direct3D version (e.g. {{Code|8.2}} is mapped to {{Code|8.1}} as DirectX 8.2 did not bring a new version of Direct3D.
 +
 +
''OpenGL versions''
  
 
{| class="mw-collapsible mw-collapsed wikitable"
 
{| class="mw-collapsible mw-collapsed wikitable"
 
|-
 
|-
! OpenGL Versions
+
! OpenGL versions !!
 +
|-
 +
| true
 
|-
 
|-
 
| 1.0
 
| 1.0
Line 93: Line 100:
 
| 4.6
 
| 4.6
 
|}
 
|}
 +
 +
''Vulkan versions''
  
 
{| class="mw-collapsible mw-collapsed wikitable"
 
{| class="mw-collapsible mw-collapsed wikitable"
 
|-
 
|-
! Vulkan Versions
+
! Vulkan versions !!
 +
|-
 +
| true
 
|-
 
|-
 
| 1.0
 
| 1.0
Line 103: Line 114:
 
|}
 
|}
  
{{ii}} The DOS row is only shown in the article when a DOS or PC booter release date row is also present in [[PCGamingWiki:Editing guide/The Infobox|the Infobox]].
+
''DOS modes''
 +
 
 
{| class="mw-collapsible mw-collapsed wikitable"
 
{| class="mw-collapsible mw-collapsed wikitable"
 
|-
 
|-
! DOS modes !! Mode description
+
! DOS modes !! Mode description !!
 
|-
 
|-
 
| <code>text</code> || Output drawn by characters rather than pixels.
 
| <code>text</code> || Output drawn by characters rather than pixels.
Line 124: Line 136:
 
| <code>svga</code> || Super Video Graphics Array
 
| <code>svga</code> || Super Video Graphics Array
 
|}
 
|}
 +
{{ii}} The DOS row is only shown in the article when a DOS or PC booter release date row is also present in [[PCGamingWiki:Editing guide/The infobox|the Infobox]].
  
 
;Syntax
 
;Syntax

Revision as of 06:51, 27 November 2022

Description

The API template contains information on what APIs and additional features does the game support.

Supported values

Direct3D versions

Direct3D versions Notable new features Notes
2
3
5
6 Multitexturing
7 Hardware Transformation, Clipping and Lighting (TCL/T&L)
8 Pixel Shader 1.0 & Vertex Shader 1.0
8.0a Pixel Shader 1.1, Pixel Shader 1.2, Pixel Shader 1.3
8.1 Pixel Shader 1.4 & Vertex Shader 1.1
9 Shader Model 2.0 (Pixel Shader 2.0 & Vertex Shader 2.0)
9.0b Pixel Shader 2.0b
9.0c Shader Model 3.0 (Pixel Shader 3.0 & Vertex Shader 3.0), GPGPU)
9Ex Windows Graphics Foundation 1.0, DXVA 1.0 Also known as 9.L or 9.0L.
10 Shader Model 4.0, Windows Graphics Foundation 2.0, DXVA 2.0
10.1 Shader Model 4.1, Windows Graphics Foundation 2.1, DXVA 2.1
11 Shader Model 5.0, Tessellation, Multithreaded rendering, Compute shaders
11.1 Stereoscopic 3D Rendering
11.2 Tiled resources
11.3 Shader Model 5.1
11.4
12 Low-level rendering API, Shader Model 6.0
The parameter will automatically map DirectX versions over to the appropriate Direct3D version (e.g. 8.2 is mapped to 8.1 as DirectX 8.2 did not bring a new version of Direct3D.

OpenGL versions

OpenGL versions
true
1.0
1.1
1.2
1.2.1
1.3
1.4
1.5
2.0
2.1
3.0
3.1
3.2
3.3
4.0
4.1
4.2
4.3
4.4
4.5
4.6

Vulkan versions

Vulkan versions
true
1.0
1.1

DOS modes

DOS modes Mode description
text Output drawn by characters rather than pixels.
hgc Hercules Graphics Card
cga Color Graphics Adapter
mcga Multi-Color Graphics Array
ega Enhanced Graphics Adapter
tga Tandy Graphics Adapter
vga Video Graphics Array
svga Super Video Graphics Array
The DOS row is only shown in the article when a DOS or PC booter release date row is also present in the Infobox.
Syntax
{{API
|direct3d versions      = 
|direct3d notes         = 
|directdraw versions    = 
|directdraw notes       = 
|wing                   = 
|wing notes             = 
|opengl versions        = 
|opengl notes           = 
|glide versions         = 
|glide notes            = 
|software mode          = 
|software mode notes    = 
|mantle support         = 
|mantle support notes   = 
|metal support          = 
|metal support notes    = 
|vulkan versions        = 
|vulkan notes           = 
|dos modes              = 
|dos modes notes        = 
|shader model versions  = 
|shader model notes     = 
|windows 32-bit exe     = 
|windows 64-bit exe     = 
|windows arm app        = 
|windows exe notes      = 
|mac os x powerpc app   = 
|macos intel 32-bit app = 
|macos intel 64-bit app = 
|macos arm app          = 
|macos app notes        = 
|linux powerpc app      = 
|linux 32-bit executable= 
|linux 64-bit executable= 
|linux arm app          = 
|linux executable notes = 
}}
Related templates