extra/gpu/shaders/shaders-docs.factor

   1 ! (c)2009 Joe Groff bsd license
   2 USING: classes classes.struct gpu.buffers help.markup help.syntax
   3 images kernel math multiline quotations sequences strings words ;
   4 IN: gpu.shaders
   5
   6 HELP: <program-instance>
   7 { $values
   8     { "program" program }
   9     { "instance" program-instance }
  10 }
  11 { $description "Compiles and links an instance of " { $snippet "program" } " for the current graphics context. If an instance already exists for " { $snippet "program" } " in the current context, it is reused." } ;
  12
  13 HELP: <shader-instance>
  14 { $values
  15     { "shader" shader }
  16     { "instance" shader-instance }
  17 }
  18 { $description "Compiles an instance of " { $snippet "shader" } " for the current graphics context. If an instance already exists for " { $snippet "shader" } " in the current context, it is reused." } ;
  19
  20 HELP: <multi-vertex-array>
  21 { $values
  22     { "vertex-formats" "a list of " { $link buffer-ptr } "/" { $link vertex-format } " pairs" }
  23     { "program-instance" program-instance }
  24     { "vertex-array" vertex-array }
  25 }
  26 { $description "Creates a new " { $link vertex-array } " to feed data to " { $snippet "program-instance" } " from the set of " { $link buffer } "s specified in " { $snippet "vertex-formats" } ". The first element of each pair in " { $snippet "vertex-formats" } " can be either a " { $link buffer-ptr } " or a " { $link buffer } "; in the latter case, vertex data in the associated format is read from the beginning of the buffer." } ;
  27
  28 HELP: feedback-format:
  29 { $syntax "feedback-format: vertex-format" }
  30 { $description "When used as part of a " { $link POSTPONE: GLSL-PROGRAM: } " definition, this syntax specifies the " { $link vertex-format } " in which transform feedback output will be generated." } ;
  31
  32 HELP: GLSL-PROGRAM:
  33 { $syntax "GLSL-PROGRAM: program-name shader shader ... [vertex-format vertex-format ...] [feedback-format: vertex-format] ;" }
  34 { $description "Defines a new " { $link program } " named " { $snippet "program-name" } ". When the program is instantiated with " { $link <program-instance> } ", it will link together instances of all of the specified " { $link shader } "s to create the program instance. If any " { $link vertex-format } "s are specified, their attributes will be pre-assigned attribute indexes at link time, to ensure that their indexes remain constant if the program is refreshed with " { $link refresh-program } ". A transform feedback vertex format may optionally be specified with " { $link POSTPONE: feedback-format: } "; if the program is used to collect transform feedback, the given vertex format will be used for the output." }
  35 { $notes "Transform feedback requires OpenGL 3.0 or one of the " { $snippet "GL_EXT_transform_feedback" } " or " { $snippet "GL_ARB_transform_feedback" } " extensions." } ;
  36
  37 HELP: GLSL-SHADER-FILE:
  38 { $syntax "GLSL-SHADER-FILE: shader-name shader-kind \"filename\"" }
  39 { $description "Defines a new " { $link shader } " of kind " { $link shader-kind } " named " { $snippet "shader-name" } ". The shader will read its source code from " { $snippet "filename" } " in the current Factor source file's directory." } ;
  40
  41 HELP: GLSL-SHADER:
  42 { $syntax "GLSL-SHADER: shader-name shader-kind
  43
  44 shader source
  45
  46 ;" }
  47 { $description "Defines a new " { $link shader } " of kind " { $link shader-kind } " named " { $snippet "shader-name" } ". The shader will read its source code from the current Factor source file between the " { $snippet "GLSL-SHADER:" } " line and the first subsequent line with a single semicolon on it." } ;
  48
  49 HELP: VERTEX-FORMAT:
  50 { $syntax "VERTEX-FORMAT: format-name
  51     { \"attribute\"/f component-type dimension normalize? }
  52     { \"attribute\"/f component-type dimension normalize? }
  53     ...
  54     { \"attribute\"/f component-type dimension normalize? } ;" }
  55 { $description "Defines a new binary " { $link vertex-format } " for structuring vertex data stored in " { $link buffer } "s. Each " { $snippet "attribute" } " name either corresponds to an input parameter of a vertex shader, or is " { $link f } " to include padding in the vertex format. The " { $link component-type } " determines the format of the components, and the " { $snippet "dimension" } " determines the number of components. If the " { $snippet "component-type" } " is an integer type and " { $snippet "normalize?" } " is true, the component values will be scaled to the range 0.0 to 1.0 when fed to the vertex shader; otherwise, they will be cast to floats retaining their integral values." } ;
  56
  57 HELP: VERTEX-STRUCT:
  58 { $syntax "VERTEX-STRUCT: struct-name format-name" }
  59 { $description "Defines a struct class (like " { $link POSTPONE: STRUCT: } ") with the same binary format and component types as the given " { $link vertex-format } "." } ;
  60
  61 { POSTPONE: GLSL-PROGRAM: POSTPONE: GLSL-SHADER-FILE: POSTPONE: GLSL-SHADER: } related-words
  62
  63 HELP: attribute-index
  64 { $values
  65     { "program-instance" program-instance } { "attribute-name" string }
  66     { "index" integer }
  67 }
  68 { $description "Returns the numeric index of the vertex attribute named " { $snippet "attribute-name" } " in " { $snippet "program-instance" } "." } ;
  69
  70 HELP: <vertex-array>
  71 { $values
  72     { "vertex-buffer" "a " { $link buffer } " or " { $link buffer-ptr } } { "program-instance" program-instance }
  73     { "vertex-array" vertex-array }
  74 }
  75 { $description "Creates a new " { $link vertex-array } " from the entire contents of a single " { $link buffer } " for use with a " { $link program-instance } ". The data in " { $snippet "buffer" } " is taken in the first " { $link vertex-format } " specified in the program instance's originating " { $link POSTPONE: GLSL-PROGRAM: } " definition. If the program has no associated vertex formats, an error will be thrown. To specify a different vertex format, use " { $link <vertex-array*> } "." } ;
  76
  77 HELP: <vertex-array*>
  78 { $values
  79     { "vertex-buffer" "a " { $link buffer } " or " { $link buffer-ptr } } { "program-instance" program-instance } { "format" vertex-format }
  80     { "vertex-array" vertex-array }
  81 }
  82 { $description "Creates a new " { $link vertex-array } " from the entire contents of a single " { $link buffer } " for use with a " { $link program-instance } ". The data in " { $snippet "buffer" } " is taken in the specified " { $link vertex-format } "." } ;
  83
  84 { vertex-array <multi-vertex-array> <vertex-array> <vertex-array*> } related-words
  85
  86 HELP: compile-shader-error
  87 { $class-description "An error compiling the source for a " { $link shader } "."
  88 { $list
  89 { "The " { $snippet "shader" } " slot indicates the shader that failed to compile." }
  90 { "The " { $snippet "log" } " slot contains the error string from the GLSL compiler." }
  91 } } ;
  92
  93 HELP: define-vertex-format
  94 { $values
  95     { "class" class } { "vertex-attributes" sequence }
  96 }
  97 { $description "Defines a new " { $link vertex-format } " with the binary format specified by the " { $link vertex-attribute } " tuple values in " { $snippet "vertex-attributes" } ". The runtime equivalent of " { $link POSTPONE: VERTEX-FORMAT: } ". This word must be called inside a compilation unit." } ;
  98
  99 HELP: define-vertex-struct
 100 { $values
 101     { "class" word } { "vertex-format" vertex-format }
 102 }
 103 { $description "Defines a new struct C type from a " { $link vertex-format } ". The runtime equivalent of " { $link POSTPONE: VERTEX-STRUCT: } ". This word must be called inside a compilation unit." } ;
 104
 105 HELP: fragment-shader
 106 { $class-description "This " { $link shader-kind } " indicates that a " { $link shader } " is a fragment shader." } ;
 107
 108 HELP: link-program-error
 109 { $class-description "An error linking the constituent shaders of a " { $link program } "."
 110 { $list
 111 { "The " { $snippet "program" } " slot indicates the program that failed to link." }
 112 { "The " { $snippet "log" } " slot contains the error string from the GLSL linker." }
 113 } } ;
 114
 115 { compile-shader-error link-program-error } related-words
 116
 117 HELP: output-index
 118 { $values
 119     { "program-instance" program-instance } { "output-name" string }
 120     { "index" integer }
 121 }
 122 { $description "Returns the numeric index of the fragment shader output named " { $snippet "output-name" } " in " { $snippet "program-instance" } "." }
 123 { $notes "Named fragment shader outputs require OpenGL 3.0 or later and GLSL 1.30 or later, or OpenGL 2.0 or later and GLSL 1.20 or earlier with the " { $snippet "GL_EXT_gpu_shader4" } " extension." } ;
 124
 125 HELP: program
 126 { $class-description "A " { $snippet "program" } " provides a specification for linking a " { $link program-instance } " in a graphics context. Programs are defined with " { $link POSTPONE: GLSL-PROGRAM: } " and instantiated for a context with " { $link <program-instance> } "." } ;
 127
 128 HELP: program-instance
 129 { $class-description "A " { $snippet "program-instance" } " is a shader " { $link program } " that has been compiled and linked for a graphics context using " { $link <program-instance> } "." } ;
 130
 131 HELP: refresh-program
 132 { $values
 133     { "program" program }
 134 }
 135 { $description "Rereads the source code for every " { $link shader } " in " { $link program } " and attempts to refresh all the existing " { $link shader-instance } "s and " { $link program-instance } "s for those shaders. If any of the new source code fails to compile or link, the existing valid shader and program instances will remain untouched. However, subsequent attempts to compile new shader or program instances will still attempt to use the new source code. If the compilation and linking succeed, the existing shader and program instances will be updated on the fly to reference the newly compiled code." } ;
 136
 137 HELP: shader
 138 { $class-description "A " { $snippet "shader" } " provides a block of GLSL source code that can be compiled into a " { $link shader-instance } " in a graphics context. Shaders are defined with " { $link POSTPONE: GLSL-SHADER: } " or " { $link POSTPONE: GLSL-SHADER-FILE: } " and instantiated for a context with " { $link <shader-instance> } "." } ;
 139
 140 HELP: shader-instance
 141 { $class-description "A " { $snippet "shader-instance" } " is a " { $link shader } " that has been compiled for a graphics context using " { $link <shader-instance> } "." } ;
 142
 143 HELP: shader-kind
 144 { $class-description "A " { $snippet "shader-kind" } " value is passed as part of a " { $link POSTPONE: GLSL-SHADER: } " or " { $link POSTPONE: GLSL-SHADER-FILE: } " definition to indicate the kind of " { $link shader } " being defined."
 145 { $list
 146 { { $link vertex-shader } "s run during primitive assembly and map input vertex data to positions in screen space for rasterization." }
 147 { { $link fragment-shader } "s run as part of rasterization and decide the final rendered output of a primitive as the outputs of the vertex shader are interpolated across its surface." }
 148 } } ;
 149
 150 HELP: too-many-feedback-formats-error
 151 { $class-description "This error is thrown when a " { $link POSTPONE: GLSL-PROGRAM: } " definition attempts to include more than one " { $link vertex-format } " for transform feedback formatting." } ;
 152
 153 HELP: invalid-link-feedback-format-error
 154 { $class-description "This error is thrown when the " { $link vertex-format } " specified as the transform feedback output format of a " { $link program } " is not suitable for the purpose. Transform feedback formats do not support padding (fields with a name of " { $link f } ")." } ;
 155
 156 HELP: inaccurate-feedback-attribute-error
 157 { $class-description "This error is thrown when the " { $link vertex-format } " specified as the transform feedback output format of a " { $link program } " does not match the format of the output attributes linked into a " { $link program-instance } "." } ;
 158
 159 HELP: uniform-index
 160 { $values
 161     { "program-instance" program-instance } { "uniform-name" string }
 162     { "index" integer }
 163 }
 164 { $description "Returns the numeric index of the uniform parameter named " { $snippet "output-name" } " in " { $snippet "program-instance" } "." } ;
 165
 166 HELP: vertex-shader
 167 { $class-description "This " { $link shader-kind } " indicates that a " { $link shader } " is a vertex shader." } ;
 168
 169 HELP: vertex-array
 170 { $class-description "A " { $snippet "vertex-array" } " object associates a shader " { $link program-instance } " with vertex attribute data from one or more " { $link buffer } "s. The format of the binary data inside these buffers is described using " { $link vertex-format } "s. " { $snippet "vertex-array" } "s are constructed using the " { $link <multi-vertex-array> } " or " { $link <vertex-array*> } " words. The actual type of a vertex-array object is opaque, but the " { $link vertex-array-buffers } " word can be used to query a vertex array object for its component buffers." } ;
 171
 172 HELP: vertex-array-buffers
 173 { $values
 174     { "vertex-array" vertex-array }
 175     { "buffers" sequence }
 176 }
 177 { $description "Returns a sequence containing all of the " { $link buffer } " objects that make up " { $snippet "vertex-array" } "." } ;
 178
 179 HELP: vertex-array-buffer
 180 { $values
 181     { "vertex-array" vertex-array }
 182     { "vertex-buffer" buffer }
 183 }
 184 { $description "Returns the first " { $link buffer } " object that makes up " { $snippet "vertex-array" } "." } ;
 185
 186 { vertex-array-buffer vertex-array-buffers } related-words
 187
 188 HELP: vertex-attribute
 189 { $class-description "This tuple type is passed to " { $link define-vertex-format } " to define a new " { $link vertex-format } " type." } ;
 190
 191 HELP: vertex-format
 192 { $class-description "This class encompasses all vertex formats defined by " { $link POSTPONE: VERTEX-FORMAT: } ". A vertex format defines the binary layout of vertex attribute data in a " { $link buffer } " for use as part of a " { $link vertex-array } ". See the " { $link POSTPONE: VERTEX-FORMAT: } " documentation for details on how vertex formats are defined." } ;
 193
 194 HELP: vertex-format-size
 195 { $values
 196     { "format" vertex-format }
 197     { "size" integer }
 198 }
 199 { $description "Returns the size in bytes of a set of vertex attributes in " { $snippet "format" } "." } ;
 200
 201 ARTICLE: "gpu.shaders" "Shader objects"
 202 "The " { $vocab-link "gpu.shaders" } " vocabulary supports defining, compiling, and linking " { $link shader } "s into " { $link program } "s that run on the GPU and control rendering."
 203 { $subsections
 204     POSTPONE: GLSL-PROGRAM:
 205     POSTPONE: GLSL-SHADER:
 206     POSTPONE: GLSL-SHADER-FILE:
 207 }
 208 "A program must be instantiated for each graphics context it is used in:"
 209 { $subsections <program-instance> }
 210 "Program instances can be updated on the fly, allowing for interactive development of shaders:"
 211 { $subsections refresh-program }
 212 "Render data inside GPU " { $link buffer } "s is organized into " { $link vertex-array } "s for consumption by shader code:"
 213 { $subsections
 214     vertex-array
 215     <multi-vertex-array>
 216     <vertex-array*>
 217     <vertex-array>
 218     POSTPONE: VERTEX-FORMAT:
 219 } ;
 220
 221 ABOUT: "gpu.shaders"