ubergames/ioef
0
0
Fork 0
mirror of https://github.com/UberGames/ioef.git synced 2024-11-23 20:52:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

s/.txt/.md/

Browse source 
Initial pass at moving the opengl readme from plaintext to markdown.
Probably screwed up a lot of stuff.
This commit is contained in:
Zachary J. Slater 2015-06-04 22:54:46 -07:00
parent 5082548bf5
commit a0d2e851cd
1 changed files with 64 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

125
opengl2-readme.txt → opengl2-readme.md
View file

@ -52,7 +52,9 @@ For Win32:
1. Start ioquake3. (ioquake3.x86.exe on Win32) 1. Start ioquake3. (ioquake3.x86.exe on Win32)
2. Open the console (default key ~) and type '/cl_renderer opengl2; vid_restart' 2. Open the console (the default key is tilde ~) and type
`/cl_renderer opengl2` and press enter
`/vid_restart` then press enter again.
3. Enjoy. 3. Enjoy.
@ -62,94 +64,94 @@ For Win32:
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Cvars for simple rendering features: Cvars for simple rendering features:
r_ext_compressed_textures - Automatically compress textures.
* `r_ext_compressed_textures` - Automatically compress textures.
0 - No texture compression. (default) 0 - No texture compression. (default)
1 - DXT/LATC texture compression if 1 - DXT/LATC texture compression if
supported. supported.
2 - BPTC texture compression if supported. 2 - BPTC texture compression if supported.
r_ext_framebuffer_multisample - Multisample Anti-aliasing. * `r_ext_framebuffer_multisample` - Multisample Anti-aliasing.
0 - None. (default) 0 - None. (default)
1-16 - Some. 1-16 - Some.
17+ - Too much! 17+ - Too much!
r_ssao - Enable screen-space ambient occlusion. * `r_ssao` - Enable screen-space ambient occlusion.
Currently eats framerate and has some Currently eats framerate and has some
visible artifacts. visible artifacts.
0 - No. (default) 0 - No. (default)
1 - Yes. 1 - Yes.
Cvars for HDR and tonemapping: Cvars for HDR and tonemapping:
r_hdr - Do scene rendering in a framebuffer with
* `r_hdr` - Do scene rendering in a framebuffer with
high dynamic range. (Less banding, and high dynamic range. (Less banding, and
exposure changes look much better) exposure changes look much better)
0 - No. 0 - No.
1 - Yes. (default) 1 - Yes. (default)
r_cameraExposure - Cheat. Alter brightness, in powers of two. * `r_cameraExposure` - Cheat. Alter brightness, in powers of two.
-2 - 4x as dark. -2 - 4x as dark.
0 - Normal. (default) 0 - Normal. (default)
0.5 - Sqrt(2)x as bright. 0.5 - Sqrt(2)x as bright.
2 - 4x as bright. 2 - 4x as bright.
r_postProcess - Enable post-processing. * `r_postProcess` - Enable post-processing.
0 - No. 0 - No.
1 - Yes. (default) 1 - Yes. (default)
r_toneMap - Enable tone mapping. Requires * `r_toneMap` - Enable tone mapping. Requires
r_hdr and r_postProcess. r_hdr and r_postProcess.
0 - No. 0 - No.
1 - Yes. (default) 1 - Yes. (default)
r_forceToneMap - Cheat. Override built-in and map tonemap * `r_forceToneMap` - Cheat. Override built-in and map tonemap settings and use cvars r_forceToneMapAvg, r_forceToneMapMin, and r_forceToneMapMax.
settings and use cvars r_forceToneMapAvg,
r_forceToneMapMin, and r_forceToneMapMax.
0 - No. (default) 0 - No. (default)
1 - Yes. 1 - Yes.
r_forceToneMapAvg - Cheat. Map average scene luminance to this * `r_forceToneMapAvg` - Cheat. Map average scene luminance to this
value, in powers of two. Requires value, in powers of two. Requires
r_forceToneMap. r_forceToneMap.
-2.0 - Dark. -2.0 - Dark.
-1.0 - Kinda dark. (default). -1.0 - Kinda dark. (default).
2.0 - Too bright. 2.0 - Too bright.
r_forceToneMapMin - Cheat. After mapping average, luminance * `r_forceToneMapMin` - Cheat. After mapping average, luminance
below this level is mapped to black. below this level is mapped to black.
Requires r_forceToneMap. Requires r_forceToneMap.
-5 - Not noticeable. -5 - Not noticeable.
-3.25 - Normal. (default) -3.25 - Normal. (default)
0.0 - Too dark. 0.0 - Too dark.
r_forceToneMapMin - Cheat. After mapping average, luminance * `r_forceToneMapMin` - Cheat. After mapping average, luminance
above this level is mapped to white. above this level is mapped to white.
Requires r_forceToneMap. Requires r_forceToneMap.
0.0 - Too bright. 0.0 - Too bright.
1.0 - Normal. (default). 1.0 - Normal. (default).
2.0 - Washed out. 2.0 - Washed out.
r_autoExposure - Do automatic exposure based on scene * `r_autoExposure` - Do automatic exposure based on scene
brightness. Hardcoded to -2 to 2 on maps brightness. Hardcoded to -2 to 2 on maps
that don't specify otherwise. Requires that don't specify otherwise. Requires
r_hdr, r_postprocess, and r_toneMap. r_hdr, r_postprocess, and r_toneMap.
0 - No. 0 - No.
1 - Yes. (default) 1 - Yes. (default)
r_forceAutoExposure - Cheat. Override built-in and map auto * `r_forceAutoExposure` - Cheat. Override built-in and map auto
exposure settings and use cvars exposure settings and use cvars
r_forceAutoExposureMin and r_forceAutoExposureMin and
r_forceAutoExposureMax. r_forceAutoExposureMax.
0 - No. (default) 0 - No. (default)
1 - Yes. 1 - Yes.
r_forceAutoExposureMin - Cheat. Set minimum exposure to this value, * `r_forceAutoExposureMin` - Cheat. Set minimum exposure to this value,
in powers of two. Requires in powers of two. Requires
r_forceAutoExpsure. r_forceAutoExpsure.
-3.0 - Dimmer. -3.0 - Dimmer.
-2.0 - Normal. (default) -2.0 - Normal. (default)
-1.0 - Brighter. -1.0 - Brighter.
r_forceAutoExposureMax - Cheat. Set maximum exposure to this value, * `r_forceAutoExposureMax` - Cheat. Set maximum exposure to this value,
in powers of two. Requires in powers of two. Requires
r_forceAutoExpsure. r_forceAutoExpsure.
1.0 - Dimmer. 1.0 - Dimmer.
@ -157,7 +159,8 @@ Cvars for HDR and tonemapping:
3.0 - Brighter. 3.0 - Brighter.
Cvars for advanced material usage: Cvars for advanced material usage:
r_normalMapping - Enable normal mapping for materials that
* `r_normalMapping` - Enable normal mapping for materials that
support it, and also specify advanced support it, and also specify advanced
shading techniques. shading techniques.
0 - No. 0 - No.
@ -167,7 +170,7 @@ Cvars for advanced material usage:
3 - Yes, and use tri-Ace's Oren-Nayar 3 - Yes, and use tri-Ace's Oren-Nayar
reflectance model. reflectance model.
r_specularMapping - Enable specular mapping for materials that * `r_specularMapping` - Enable specular mapping for materials that
support it, and also specify advanced support it, and also specify advanced
specular techniques. specular techniques.
0 - No. 0 - No.
@ -176,7 +179,7 @@ Cvars for advanced material usage:
3 - Yes, and use Cook-Torrance. 3 - Yes, and use Cook-Torrance.
4 - Yes, and use Torrance-Sparrow. 4 - Yes, and use Torrance-Sparrow.
r_deluxeMapping - Enable deluxe mapping. (Map is compiled * `r_deluxeMapping` - Enable deluxe mapping. (Map is compiled
with light directions.) Even if the map with light directions.) Even if the map
doesn't have deluxe mapping compiled in, doesn't have deluxe mapping compiled in,
an approximation based on the lightgrid an approximation based on the lightgrid
@ -184,27 +187,27 @@ Cvars for advanced material usage:
0 - No. 0 - No.
1 - Yes. (default) 1 - Yes. (default)
r_parallaxMapping - Enable parallax mapping for materials that * `r_parallaxMapping` - Enable parallax mapping for materials that
support it. support it.
0 - No. (default) 0 - No. (default)
1 - Use parallax occlusion mapping. 1 - Use parallax occlusion mapping.
2 - Use relief mapping. (slower) 2 - Use relief mapping. (slower)
r_baseSpecular - Set the specular reflectance of materials * `r_baseSpecular` - Set the specular reflectance of materials
which don't include a specular map or which don't include a specular map or
use the specularReflectance keyword. use the specularReflectance keyword.
0 - No. 0 - No.
0.04 - Realistic. (default) 0.04 - Realistic. (default)
1.0 - Ack. 1.0 - Ack.
r_baseGloss - Set the glossiness of materials which don't * `r_baseGloss` - Set the glossiness of materials which don't
include a specular map or use the include a specular map or use the
specularExponent keyword. specularExponent keyword.
0 - Rough. 0 - Rough.
0.3 - Default. 0.3 - Default.
1.0 - Shiny. 1.0 - Shiny.
r_baseNormalX - Set the scale of the X values from normal * `r_baseNormalX` - Set the scale of the X values from normal
maps when the normalScale keyword is not maps when the normalScale keyword is not
used. used.
-1 - Flip X. -1 - Flip X.
@ -212,7 +215,7 @@ Cvars for advanced material usage:
1 - Normal X. (default) 1 - Normal X. (default)
2 - Double X. 2 - Double X.
r_baseNormalY - Set the scale of the Y values from normal * `r_baseNormalY` - Set the scale of the Y values from normal
maps when the normalScale keyword is not maps when the normalScale keyword is not
used. used.
-1 - Flip Y. -1 - Flip Y.
@ -220,7 +223,7 @@ Cvars for advanced material usage:
1 - Normal Y. (default) 1 - Normal Y. (default)
2 - Double Y. 2 - Double Y.
r_baseParallax - Sets the scale of the parallax effect for * `r_baseParallax` - Sets the scale of the parallax effect for
materials when the parallaxDepth keyword materials when the parallaxDepth keyword
is not used. is not used.
0 - No depth. 0 - No depth.
@ -229,7 +232,8 @@ Cvars for advanced material usage:
0.1 - Looks broken. 0.1 - Looks broken.
Cvars for image interpolation and generation: Cvars for image interpolation and generation:
r_imageUpsample - Use interpolation to artifically increase
* `r_imageUpsample` - Use interpolation to artifically increase
the resolution of all textures. Looks good the resolution of all textures. Looks good
in certain circumstances. in certain circumstances.
0 - No. (default) 0 - No. (default)
@ -237,50 +241,48 @@ Cvars for image interpolation and generation:
2 - 4x size. 2 - 4x size.
3 - 8x size, etc 3 - 8x size, etc
r_imageUpsampleMaxSize - Maximum texture size when upsampling * `r_imageUpsampleMaxSize` - Maximum texture size when upsampling
textures. textures.
1024 - Default. 1024 - Default.
2048 - Really nice. 2048 - Really nice.
4096 - Really slow. 4096 - Really slow.
8192 - Crash. 8192 - Crash.
r_imageUpsampleType - Type of interpolation when upsampling * `r_imageUpsampleType` - Type of interpolation when upsampling
textures. textures.
0 - None. (probably broken) 0 - None. (probably broken)
1 - Bad but fast (default, 1 - Bad but fast (default,
FCBI without second derivatives) FCBI without second derivatives)
2 - Okay but slow (normal FCBI) 2 - Okay but slow (normal FCBI)
r_genNormalMaps - Naively generate normal maps for all * `r_genNormalMaps* - Naively generate normal maps for all
textures. textures.
0 - Don't. (default) 0 - Don't. (default)
1 - Do. 1 - Do.
Cvars for the sunlight and cascaded shadow maps: Cvars for the sunlight and cascaded shadow maps:
r_forceSun - Cheat. Force sunlight and shadows, using sun
position from sky material. * `r_forceSun` - Cheat. Force sunlight and shadows, using sun position from sky material.
0 - Don't. (default) 0 - Don't. (default)
1 - Do. 1 - Do.
2 - Sunrise, sunset. 2 - Sunrise, sunset.
r_forceSunMapLightScale - Cheat. Scale map brightness by this factor * `r_forceSunMapLightScale` - Cheat. Scale map brightness by this factor
when r_forceSun 1. when r_forceSun 1.
1.0 - Default 1.0 - Default
r_forceSunLightScale - Cheat. Scale sun brightness by this factor * `r_forceSunLightScale` - Cheat. Scale sun brightness by this factor
when r_forceSun 1. when r_forceSun 1.
1.0 - Default 1.0 - Default
r_forceSunAmbientScale - Cheat. Scale sun ambient brightness by this
factor when r_forceSun 1.
0.5 - Default
r_sunShadows - Enable sunlight and cascaded shadow maps for * `r_forceSunAmbientScale` - Cheat. Scale sun ambient brightness by this factor when r_forceSun 1. 0.5 - Default
* `r_sunShadows` - Enable sunlight and cascaded shadow maps for
it on maps that support it. it on maps that support it.
0 - No. 0 - No.
1 - Yes. (default) 1 - Yes. (default)
r_sunlightMode - Specify the method used to add sunlight to * `r_sunlightMode` - Specify the method used to add sunlight to
the scene. the scene.
0 - No. 0 - No.
1 - Multiply lit areas by light scale, and 1 - Multiply lit areas by light scale, and
@ -290,13 +292,13 @@ Cvars for the sunlight and cascaded shadow maps:
and doesn't integrate well with existing and doesn't integrate well with existing
maps. maps.
r_shadowFilter - Enable filtering shadows for a smoother * `r_shadowFilter` - Enable filtering shadows for a smoother
look. look.
0 - No. 0 - No.
1 - Some. (default) 1 - Some. (default)
2 - Much. 2 - Much.
r_shadowMapSize - Size of each cascaded shadow map. * `r_shadowMapSize` - Size of each cascaded shadow map.
256 - 256x256, ugly, probably shouldn't 256 - 256x256, ugly, probably shouldn't
go below this. go below this.
512 - 512x512, passable. 512 - 512x512, passable.
@ -306,77 +308,78 @@ Cvars for the sunlight and cascaded shadow maps:
2048. 2048.
Cvars that you probably don't care about or shouldn't mess with: Cvars that you probably don't care about or shouldn't mess with:
r_mergeMultidraws - Optimize number of calls to
* `r_mergeMultidraws` - Optimize number of calls to
glMultiDrawElements(). glMultiDrawElements().
0 - Don't. 0 - Don't.
1 - Do some. (default) 1 - Do some. (default)
2 - Do more than necessary (eats CPU). 2 - Do more than necessary (eats CPU).
r_mergeLeafSurfaces - Merge surfaces that share common materials * `r_mergeLeafSurfaces` - Merge surfaces that share common materials
and a common leaf. Speeds up rendering. and a common leaf. Speeds up rendering.
0 - Don't. 0 - Don't.
1 - Do. (default) 1 - Do. (default)
r_recalcMD3Normals - Recalculate the normals when loading an MD3. * `r_recalcMD3Normals` - Recalculate the normals when loading an MD3.
Fixes normal maps in some cases but looks Fixes normal maps in some cases but looks
ugly in others. ugly in others.
0 - Don't. (default) 0 - Don't. (default)
1 - Do. 1 - Do.
r_depthPrepass - Do a depth-only pass before rendering. * `r_depthPrepass` - Do a depth-only pass before rendering.
Speeds up rendering in cases where advanced Speeds up rendering in cases where advanced
features are used. Required for features are used. Required for
r_sunShadows. r_sunShadows.
0 - No. 0 - No.
1 - Yes. (default) 1 - Yes. (default)
r_normalAmbient - Split map light into ambient and directed * `r_normalAmbient` - Split map light into ambient and directed
portions when doing deluxe mapping. Not portions when doing deluxe mapping. Not
very useful. very useful.
0 - Don't. (default). 0 - Don't. (default).
0.3 - 30% ambient, 70% directed. 0.3 - 30% ambient, 70% directed.
1.0 - 100% ambient. 1.0 - 100% ambient.
r_mergeLightmaps - Merge the small (128x128) lightmaps into * `r_mergeLightmaps` - Merge the small (128x128) lightmaps into
2 or fewer giant (4096x4096) lightmaps. 2 or fewer giant (4096x4096) lightmaps.
Easy speedup. Easy speedup.
0 - Don't. 0 - Don't.
1 - Do. (default) 1 - Do. (default)
r_shadowCascadeZNear - Near plane for shadow cascade frustums. * `r_shadowCascadeZNear` - Near plane for shadow cascade frustums.
4 - Default. 4 - Default.
r_shadowCascadeZFar - Far plane for shadow cascade frustums. * `r_shadowCascadeZFar` - Far plane for shadow cascade frustums.
3072 - Default. 3072 - Default.
r_shadowCascadeZBias - Z-bias for shadow cascade frustums. * `r_shadowCascadeZBias` - Z-bias for shadow cascade frustums.
-256 - Default. -256 - Default.
r_materialGamma - Gamma level for material textures. * `r_materialGamma` - Gamma level for material textures.
(diffuse, specular) (diffuse, specular)
1.0 - Quake 3, fastest. (default) 1.0 - Quake 3, fastest. (default)
r_lightGamma - Gamma level for light. * `r_lightGamma` - Gamma level for light.
(lightmap, lightgrid, vertex lights) (lightmap, lightgrid, vertex lights)
1.0 - Quake 3, fastest. (default) 1.0 - Quake 3, fastest. (default)
r_framebufferGamma - Gamma level for framebuffers. * `r_framebufferGamma` - Gamma level for framebuffers.
1.0 - Quake 3, fastest. (default) 1.0 - Quake 3, fastest. (default)
r_tonemapGamma - Gamma applied after tonemapping. * `r_tonemapGamma` - Gamma applied after tonemapping.
1.0 - Quake 3, fastest. (default) 1.0 - Quake 3, fastest. (default)
Cvars that have broken bits: Cvars that have broken bits:
r_dlightMode - Change how dynamic lights look.
* `r_dlightMode` - Change how dynamic lights look.
0 - Quake 3 style dlights, fake 0 - Quake 3 style dlights, fake
brightening. (default) brightening. (default)
1 - Actual lighting, no shadows. 1 - Actual lighting, no shadows.
2 - Light and shadows. (broken) 2 - Light and shadows. (broken)
r_pshadowDist - Virtual camera distance when creating shadow * `r_pshadowDist` - Virtual camera distance when creating shadowmaps for projected shadows. Deprecated.
maps for projected shadows. Deprecated.
* `cg_shadows` - Old shadow code. Deprecated.
cg_shadows - Old shadow code. Deprecated.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------