From 9f936f2001116d75b1bc5b086b9ff6d5d415bb60 Mon Sep 17 00:00:00 2001
From: Corbin Simpson
Date: Sun, 20 Dec 2009 17:25:44 -0800
Subject: [PATCH] Regenerate docs.
---
src/gallium/docs/build/html/_sources/cso.txt | 7 ++
src/gallium/docs/build/html/_sources/cso/blend.txt | 2 +-
src/gallium/docs/build/html/_sources/cso/dsa.txt | 39 ++++++++++-
.../docs/build/html/_sources/cso/rasterizer.txt | 76 +++++++++++++++++++-
.../docs/build/html/_sources/cso/sampler.txt | 36 +++++++++-
src/gallium/docs/build/html/cso.html | 11 +++
src/gallium/docs/build/html/cso/blend.html | 2 +-
src/gallium/docs/build/html/cso/dsa.html | 44 +++++++++++-
src/gallium/docs/build/html/cso/rasterizer.html | 81 +++++++++++++++++++++-
src/gallium/docs/build/html/cso/sampler.html | 36 +++++++++-
src/gallium/docs/build/html/searchindex.js | 2 +-
src/gallium/docs/build/html/tgsi.html | 10 +--
12 files changed, 328 insertions(+), 18 deletions(-)
diff --git a/src/gallium/docs/build/html/_sources/cso.txt b/src/gallium/docs/build/html/_sources/cso.txt
index f00cc51..dab1ee5 100644
--- a/src/gallium/docs/build/html/_sources/cso.txt
+++ b/src/gallium/docs/build/html/_sources/cso.txt
@@ -1,6 +1,13 @@
CSO
===
+CSO, Constant State Objects, are a core part of Gallium's API.
+
+CSO work on the principle of reusable state; they are created by filling
+out a state object with the desired properties, then passing that object
+to a context. The context returns an opaque context-specific handle which
+can be bound at any time for the desired effect.
+
.. toctree::
:glob:
diff --git a/src/gallium/docs/build/html/_sources/cso/blend.txt b/src/gallium/docs/build/html/_sources/cso/blend.txt
index e32d324..608f369 100644
--- a/src/gallium/docs/build/html/_sources/cso/blend.txt
+++ b/src/gallium/docs/build/html/_sources/cso/blend.txt
@@ -9,4 +9,4 @@ XXX it is unresolved what behavior should result if blend_enable is off.
Members
-------
-XXX
+XXX undocumented members
diff --git a/src/gallium/docs/build/html/_sources/cso/dsa.txt b/src/gallium/docs/build/html/_sources/cso/dsa.txt
index 5f23896..0be7af5 100644
--- a/src/gallium/docs/build/html/_sources/cso/dsa.txt
+++ b/src/gallium/docs/build/html/_sources/cso/dsa.txt
@@ -7,17 +7,50 @@ discard fragments that have passed through the fragment shader.
Traditionally, these three tests have been clumped together in hardware, so
they are all stored in one structure.
+During actual execution, the order of operations done on fragments is always:
+
+* Stencil
+* Depth
+* Alpha
+
Depth Members
-------------
-XXX
+enabled
+ Whether the depth test is enabled.
+writemask
+ Whether the depth buffer receives depth writes.
+func
+ The depth test function. One of PIPE_FUNC.
Stencil Members
---------------
-XXX
+XXX document valuemask, writemask
+
+enabled
+ Whether the stencil test is enabled. For the second stencil, whether the
+ two-sided stencil is enabled.
+func
+ The stencil test function. One of PIPE_FUNC.
+ref_value
+ Stencil test reference value; used for certain functions.
+fail_op
+ The operation to carry out if the stencil test fails. One of
+ PIPE_STENCIL_OP.
+zfail_op
+ The operation to carry out if the stencil test passes but the depth test
+ fails. One of PIPE_STENCIL_OP.
+zpass_op
+ The operation to carry out if the stencil test and depth test both pass.
+ One of PIPE_STENCIL_OP.
Alpha Members
-------------
-XXX
+enabled
+ Whether the alpha test is enabled.
+func
+ The alpha test function. One of PIPE_FUNC.
+ref_value
+ Alpha test reference value; used for certain functions.
diff --git a/src/gallium/docs/build/html/_sources/cso/rasterizer.txt b/src/gallium/docs/build/html/_sources/cso/rasterizer.txt
index 145ce25..b87d121 100644
--- a/src/gallium/docs/build/html/_sources/cso/rasterizer.txt
+++ b/src/gallium/docs/build/html/_sources/cso/rasterizer.txt
@@ -7,4 +7,78 @@ interpolated into fragments.
Members
-------
-XXX
+XXX undocumented light_twoside, front_winding, cull_mode, fill_cw, fill_ccw, offset_cw, offset_ccw
+XXX moar undocumented poly_smooth, line_stipple_factor, line_last_pixel, offset_units, offset_scale
+XXX sprite_coord_mode
+
+flatshade
+ If set, the provoking vertex of each polygon is used to determine the
+ color of the entire polygon. If not set, the color fragments will be
+ interpolated from each vertex's color.
+scissor
+ Whether the scissor test is enabled.
+poly_stipple_enable
+ Whether polygon stippling is enabled.
+point_smooth
+ Whether points should be smoothed. Point smoothing turns rectangular
+ points into circles or ovals.
+point_sprite
+ Whether point sprites are enabled.
+point_size_per_vertex
+ Whether vertices have a point size element.
+multisample
+ Whether MSAA is enabled.
+line_smooth
+ Whether lines should be smoothed. Line smoothing is simply anti-aliasing.
+line_stipple_enable
+ Whether line stippling is enabled.
+line_stipple_pattern
+ 16-bit bitfield of on/off flags, used to pattern the line stipple.
+bypass_vs_clip_and_viewport
+ Whether the entire TCL pipeline should be bypassed. This implies that
+ vertices are pre-transformed for the viewport, and will not be run
+ through the vertex shader. Note that implementations may still clip away
+ vertices that are not in the viewport.
+flatshade_first
+ Whether the first vertex should be the provoking vertex, for most
+ primitives. If not set, the last vertex is the provoking vertex.
+gl_rasterization_rules
+ Whether the rasterizer should use (0.5, 0.5) pixel centers. When not set,
+ the rasterizer will use (0, 0) for pixel centers.
+line_width
+ The width of lines.
+point_size
+ The size of points, if not specified per-vertex.
+point_size_min
+ The minimum size of points.
+point_size_max
+ The maximum size of points.
+
+Notes
+-----
+
+flatshade
+^^^^^^^^^
+
+The actual interpolated shading algorithm is obviously
+implementation-dependent, but will usually be Gourard for most hardware.
+
+bypass_vs_clip_and_viewport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When set, this implies that vertices are pre-transformed for the viewport, and
+will not be run through the vertex shader. Note that implementations may still
+clip away vertices that are not visible.
+
+flatshade_first
+^^^^^^^^^^^^^^^
+
+There are several important exceptions to the specification of this rule.
+
+* PIPE_PRIMITIVE_POLYGON: The provoking vertex is always the first vertex.
+ If the caller wishes to change the provoking vertex, they merely need to
+ rotate the vertices themselves.
+* PIPE_PRIMITIVE_QUAD, PIPE_PRIMITIVE_QUAD_STRIP: This option has no effect.
+* PIPE_PRIMITIVE_TRIANGLE_FAN: When set, the provoking vertex is the second
+ vertex, not the first. This permits each segment of the fan to have a
+ different color.
diff --git a/src/gallium/docs/build/html/_sources/cso/sampler.txt b/src/gallium/docs/build/html/_sources/cso/sampler.txt
index 09b959f..3a63ac6 100644
--- a/src/gallium/docs/build/html/_sources/cso/sampler.txt
+++ b/src/gallium/docs/build/html/_sources/cso/sampler.txt
@@ -4,7 +4,41 @@ Sampler
Texture units have many options for selecting texels from loaded textures;
this state controls an individual texture unit's texel-sampling settings.
+Texture coordinates are always treated as four-dimensional, and referred to
+with the traditional (S, T, R, Q) notation.
+
Members
-------
-XXX
+XXX undocumented compare_mode, compare_func
+
+wrap_s
+ How to wrap the S coordinate. One of PIPE_TEX_WRAP.
+wrap_t
+ How to wrap the T coordinate. One of PIPE_TEX_WRAP.
+wrap_r
+ How to wrap the R coordinate. One of PIPE_TEX_WRAP.
+min_img_filter
+ The filter to use when minifying texels. One of PIPE_TEX_FILTER.
+min_mip_filter
+ The filter to use when minifying mipmapped textures. One of
+ PIPE_TEX_FILTER.
+mag_img_filter
+ The filter to use when magnifying texels. One of PIPE_TEX_FILTER.
+normalized_coords
+ Whether the texture coordinates are normalized. If normalized, they will
+ always be in [0, 1]. If not, they will be in the range of each dimension
+ of the loaded texture.
+prefilter
+ XXX From the Doxy, "weird sampling state exposed by some APIs." Refine.
+lod_bias
+ The bias to apply to the level of detail.
+min_lod
+ Minimum level of detail, used to clamp LoD after bias.
+max_lod
+ Maximum level of detail, used to clamp LoD after bias.
+border_color
+ RGBA color used for out-of-bounds coordinates.
+max_anisotropy
+ Maximum filtering to apply anisotropically to textures. Setting this to
+ 1.0 effectively disables anisotropic filtering.
diff --git a/src/gallium/docs/build/html/cso.html b/src/gallium/docs/build/html/cso.html
index 7679a08..24aa6d7 100644
--- a/src/gallium/docs/build/html/cso.html
+++ b/src/gallium/docs/build/html/cso.html
@@ -47,6 +47,11 @@
CSO, Constant State Objects, are a core part of Gallium’s API.
+
CSO work on the principle of reusable state; they are created by filling
+out a state object with the desired properties, then passing that object
+to a context. The context returns an opaque context-specific handle which
+can be bound at any time for the desired effect.
diff --git a/src/gallium/docs/build/html/cso/dsa.html b/src/gallium/docs/build/html/cso/dsa.html
index c35b946..ec73a03 100644
--- a/src/gallium/docs/build/html/cso/dsa.html
+++ b/src/gallium/docs/build/html/cso/dsa.html
@@ -53,17 +53,55 @@
discard fragments that have passed through the fragment shader.
Traditionally, these three tests have been clumped together in hardware, so
they are all stored in one structure.
+
During actual execution, the order of operations done on fragments is always:
If set, the provoking vertex of each polygon is used to determine the
+color of the entire polygon. If not set, the color fragments will be
+interpolated from each vertex’s color.
+
scissor
+
Whether the scissor test is enabled.
+
poly_stipple_enable
+
Whether polygon stippling is enabled.
+
point_smooth
+
Whether points should be smoothed. Point smoothing turns rectangular
+points into circles or ovals.
+
point_sprite
+
Whether point sprites are enabled.
+
point_size_per_vertex
+
Whether vertices have a point size element.
+
multisample
+
Whether MSAA is enabled.
+
line_smooth
+
Whether lines should be smoothed. Line smoothing is simply anti-aliasing.
+
line_stipple_enable
+
Whether line stippling is enabled.
+
line_stipple_pattern
+
16-bit bitfield of on/off flags, used to pattern the line stipple.
+
bypass_vs_clip_and_viewport
+
Whether the entire TCL pipeline should be bypassed. This implies that
+vertices are pre-transformed for the viewport, and will not be run
+through the vertex shader. Note that implementations may still clip away
+vertices that are not in the viewport.
+
flatshade_first
+
Whether the first vertex should be the provoking vertex, for most
+primitives. If not set, the last vertex is the provoking vertex.
+
gl_rasterization_rules
+
Whether the rasterizer should use (0.5, 0.5) pixel centers. When not set,
+the rasterizer will use (0, 0) for pixel centers.
When set, this implies that vertices are pre-transformed for the viewport, and
+will not be run through the vertex shader. Note that implementations may still
+clip away vertices that are not visible.
There are several important exceptions to the specification of this rule.
+
+
PIPE_PRIMITIVE_POLYGON: The provoking vertex is always the first vertex.
+If the caller wishes to change the provoking vertex, they merely need to
+rotate the vertices themselves.
+
PIPE_PRIMITIVE_QUAD, PIPE_PRIMITIVE_QUAD_STRIP: This option has no effect.
+
PIPE_PRIMITIVE_TRIANGLE_FAN: When set, the provoking vertex is the second
+vertex, not the first. This permits each segment of the fan to have a
+different color.
How to wrap the S coordinate. One of PIPE_TEX_WRAP.
+
wrap_t
+
How to wrap the T coordinate. One of PIPE_TEX_WRAP.
+
wrap_r
+
How to wrap the R coordinate. One of PIPE_TEX_WRAP.
+
min_img_filter
+
The filter to use when minifying texels. One of PIPE_TEX_FILTER.
+
min_mip_filter
+
The filter to use when minifying mipmapped textures. One of
+PIPE_TEX_FILTER.
+
mag_img_filter
+
The filter to use when magnifying texels. One of PIPE_TEX_FILTER.
+
normalized_coords
+
Whether the texture coordinates are normalized. If normalized, they will
+always be in [0, 1]. If not, they will be in the range of each dimension
+of the loaded texture.
+
prefilter
+
XXX From the Doxy, “weird sampling state exposed by some APIs.” Refine.
+
lod_bias
+
The bias to apply to the level of detail.
+
min_lod
+
Minimum level of detail, used to clamp LoD after bias.
+
max_lod
+
Maximum level of detail, used to clamp LoD after bias.
+
border_color
+
RGBA color used for out-of-bounds coordinates.
+
max_anisotropy
+
Maximum filtering to apply anisotropically to textures. Setting this to
+1.0 effectively disables anisotropic filtering.
+
diff --git a/src/gallium/docs/build/html/searchindex.js b/src/gallium/docs/build/html/searchindex.js
index d79db36..0070652 100644
--- a/src/gallium/docs/build/html/searchindex.js
+++ b/src/gallium/docs/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({desctypes:{},terms:{represent:3,all:[3,10],through:10,abil:8,languag:3,access:8,onli:3,render:[7,8],intermedi:3,should:7,sampler:[0,1,9],main:5,straightforward:6,fragment:[7,5,10],agnost:6,tungsten:3,amp:10,tgsi_token:4,introduct:[0,6],list:4,token:4,page:0,set:9,chunk:5,blend_en:7,member:[1,5,4,7,9,10],sampl:9,result:7,pass:10,purest:8,textur:9,index:0,what:[0,6,7],content:0,state:[10,7,5,9],larg:6,select:9,hardwar:[6,10],"import":3,method:[0,2,8],core:6,screen:[0,2],inher:3,vertic:5,sinc:3,raster:[0,1,5],search:0,gallium:[0,3,6,4],shader:[0,1,3,4,10],context:[0,2,8],mani:9,clump:10,load:9,directli:8,modul:0,independ:2,three:10,instruct:3,api:[3,6],unit:9,stencil:[0,1,10],from:9,describ:3,support:4,devic:[2,6,8],two:4,been:10,type:4,individu:9,store:10,option:9,xxx:[2,5,7,8,9,10],part:[2,3],togeth:10,off:7,graphic:[3,6],target:7,provid:6,servic:6,structur:10,"final":7,behavior:7,control:[10,7,5,9],fashion:6,encapsul:6,indic:0,repres:[2,8],manner:6,have:[10,9],tabl:0,sever:6,cso:[0,1],thei:10,unresolv:7,write:6,how:5,which:6,test:10,document:0,pipelin:8,texel:9,buffer:7,object:[2,6,8],driver:[3,6],most:8,discard:10,alpha:[0,1,10],tradition:10,welcom:0,essenti:6,tgsi:[0,3],depth:[0,1,10],thi:[7,9],interpol:5,blend:[0,1,7]},titles:["Welcome to Gallium’s documentation!","CSO","Screen","TGSI","Shader","Rasterizer","Introduction","Blend","Context","Sampler","Depth, Stencil, & Alpha"],modules:{},descrefs:{},filenames:["index","cso","screen","tgsi","cso/shader","cso/rasterizer","intro","cso/blend","context","cso/sampler","cso/dsa"]})
\ No newline at end of file
+Search.setIndex({desctypes:{},terms:{represent:3,all:[3,10],rotat:5,execut:10,textur:9,thi:[7,5,9],both:10,wrap_:9,four:9,tcl:5,through:[5,10],compare_mod:9,abil:8,undocu:[7,5,9],still:5,languag:3,member:[1,5,4,7,9,10],content:0,onli:3,depend:5,render:[7,8],expos:9,front_wind:5,point_sprit:5,intermedi:3,except:5,should:[7,5],color:[5,9],pipe_tex_filt:9,scissor:5,bypass:5,sampler:[0,1,9],main:5,bypass_vs_clip_and_viewport:[1,5],pipe_tex_wrap:9,usual:5,"return":1,straightforward:6,notat:9,handl:1,agnost:6,load:9,bia:9,test:[5,10],line_smooth:5,cull_mod:5,magnifi:9,"import":[3,5],tungsten:3,amp:10,bit:5,tgsi_token:4,introduct:[0,6],document:[0,10],enabl:[5,10],specif:[1,5],level:9,off:[7,5],list:4,point_siz:5,pipe_primitive_triangle_fan:5,token:4,prefilt:9,each:[5,9],done:10,anisotrop:9,side:10,doxi:9,mag_img_filt:9,dimens:9,impli:5,set:[5,9],specifi:5,chunk:5,some:9,blend_en:7,properti:1,maximum:[5,9],wrap:9,second:[5,10],wrap_t:9,sampl:9,result:7,pass:[1,10],fail:10,light_twosid:5,zfail_op:10,purest:8,out:[1,10,9],ref_valu:10,index:0,what:[0,6,7],sprite_coord_mod:5,pattern:5,per:5,point_smooth:5,access:8,state:[1,10,7,5,9],larg:6,select:9,rgba:9,hardwar:[6,5,10],determin:5,awai:5,method:[0,2,8],refer:[10,9],core:[1,6],after:9,themselv:5,driver:[3,6],screen:[0,2],offset_cw:5,min_mip_filt:9,compare_func:9,effect:[1,5,9],control:[10,7,5,9],entir:5,lod_bia:9,inher:3,vertic:5,sinc:3,valu:10,describ:3,writemask:10,line_stipple_factor:5,search:0,actual:[5,10],most:[5,8],border_color:9,rule:5,gallium:[0,1,3,6,4],shader:[0,1,3,5,4,10],pixel:5,page:0,filter:9,turn:5,min_lod:9,context:[0,1,2,8],permit:5,discard:10,chang:5,offset_ccw:5,clump:10,gourard:5,first:5,oper:10,clamp:9,rang:9,simpli:5,max_lod:9,directli:8,point:5,carri:10,appli:9,modul:0,independ:2,pipe_primitive_quad_strip:5,three:10,instruct:3,api:[1,3,6,9],anti:5,provok:5,visibl:5,oval:5,mere:5,unit:9,size:5,flatshade_first:[1,5],differ:5,stencil:[0,1,10],from:[5,9],offset_unit:5,lod:9,support:4,devic:[2,6,8],transform:5,been:10,fail_op:10,width:5,treat:9,circl:5,time:1,individu:9,type:4,moar:5,store:10,dimension:9,"function":10,desir:1,option:[5,9],reusabl:1,normalized_coord:9,xxx:[2,5,7,8,9,10],thei:[1,10,5,9],pipe_stencil_op:10,mipmap:9,coordin:9,flag:5,point_size_max:5,minifi:9,togeth:10,func:10,fill_ccw:5,last:5,line:5,repres:[2,8],point_size_min:5,viewport:5,poly_smooth:5,line_stipple_en:5,graphic:[3,6],target:7,refin:9,whether:[10,5,9],wish:5,servic:6,caller:5,smooth:5,msaa:5,structur:10,rectangular:5,stippl:5,max_anisotropi:9,obvious:5,can:1,behavior:7,line_stipple_pattern:5,welcom:0,offset_scal:5,wrap_r:9,pre:5,fashion:6,constant:1,encapsul:6,clip:5,"final":7,certain:10,dure:10,ani:1,indic:0,bitfield:5,minimum:[5,9],implement:5,manner:6,have:[10,5,9],tabl:0,need:5,min_img_filt:9,creat:1,work:1,primit:5,sever:[6,5],sprite:5,alwai:[10,5,9],point_size_per_vertex:5,polygon:5,unresolv:7,alpha:[0,1,10],receiv:10,write:[6,10],fill_cw:5,when:[5,9],detail:9,note:[1,5],how:[5,9],run:5,flatshad:[1,5],zpass_op:10,which:[1,6],pipe_func:10,raster:[0,1,5],texel:9,pipelin:[5,8],pipe_primitive_quad:5,shade:5,normal:9,buffer:[7,10],object:[1,6,2,8],vertex:5,cso:[0,1],fragment:[7,5,10],two:[4,10],mani:9,mai:5,fill:1,pipe_primitive_polygon:5,segment:5,weird:9,line_last_pixel:5,tradit:9,bound:[1,9],multisampl:5,principl:1,essenti:6,center:5,algorithm:5,gl_rasterization_rul:5,tgsi:[0,3],tradition:10,disabl:9,alias:5,depth:[0,1,10],part:[1,3,2],poly_stipple_en:5,valuemask:10,interpol:5,fan:5,element:5,line_width:5,blend:[0,1,7],order:10,provid:6,opaqu:1},titles:["Welcome to Gallium’s documentation!","CSO","Screen","TGSI","Shader","Rasterizer","Introduction","Blend","Context","Sampler","Depth, Stencil, & Alpha"],modules:{},descrefs:{},filenames:["index","cso","screen","tgsi","cso/shader","cso/rasterizer","intro","cso/blend","context","cso/sampler","cso/dsa"]})
\ No newline at end of file
diff --git a/src/gallium/docs/build/html/tgsi.html b/src/gallium/docs/build/html/tgsi.html
index 6bc23b3..ede551e 100644
--- a/src/gallium/docs/build/html/tgsi.html
+++ b/src/gallium/docs/build/html/tgsi.html
@@ -20,7 +20,7 @@
-
+
@@ -31,7 +31,7 @@
index