extra/gpu/shaders/shaders-docs.factor

   1 ! Copyright (C) 2009 Joe Groff.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: classes classes.struct gpu.buffers help.markup help.syntax
   4 images kernel math multiline quotations sequences strings words ;
   5 IN: gpu.shaders
   6
   7 HELP: <program-instance>
   8 { $values
   9     { "program" program }
  10     { "instance" program-instance }
  11 }
  12 { $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." } ;
  13
  14 HELP: <shader-instance>
  15 { $values
  16     { "shader" shader }
  17     { "instance" shader-instance }
  18 }
  19 { $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." } ;
  20
  21 HELP: <multi-vertex-array>
  22 { $values
  23     { "vertex-formats" "a list of " { $link buffer-ptr } "/" { $link vertex-format } " pairs" }
  24     { "program-instance" program-instance }
  25     { "vertex-array" vertex-array }
  26 }
  27 { $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." } ;
  28
  29 HELP: feedback-format:
  30 { $syntax "feedback-format: vertex-format" }
  31 { $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." } ;
  32
  33 HELP: GLSL-PROGRAM:
  34 { $syntax "GLSL-PROGRAM: program-name shader shader ... [vertex-format vertex-format ...] [feedback-format: vertex-format] ;" }
  35 { $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." }
  36 { $notes "Transform feedback requires OpenGL 3.0 or one of the " { $snippet "GL_EXT_transform_feedback" } " or " { $snippet "GL_ARB_transform_feedback" } " extensions." } ;
  37
  38 HELP: GLSL-SHADER-FILE:
  39 { $syntax "GLSL-SHADER-FILE: shader-name shader-kind \"filename\"" }
  40 { $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." } ;
  41
  42 HELP: GLSL-SHADER:
  43 { $syntax "GLSL-SHADER: shader-name shader-kind
  44
  45 shader source
  46
  47 ;" }
  48 { $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." } ;
  49
  50 HELP: VERTEX-FORMAT:
  51 { $syntax "VERTEX-FORMAT: format-name
  52     { \"attribute\"/f component-type dimension normalize? }
  53     { \"attribute\"/f component-type dimension normalize? }
  54     ...
  55     { \"attribute\"/f component-type dimension normalize? } ;" }
  56 { $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." } ;
  57
  58 HELP: VERTEX-STRUCT:
  59 { $syntax "VERTEX-STRUCT: struct-name format-name" }
  60 { $description "Defines a struct class (like " { $link POSTPONE: STRUCT: } ") with the same binary format and component types as the given " { $link vertex-format } "." } ;
  61
  62 { POSTPONE: GLSL-PROGRAM: POSTPONE: GLSL-SHADER-FILE: POSTPONE: GLSL-SHADER: } related-words
  63
  64 HELP: attribute-index
  65 { $values
  66     { "program-instance" program-instance } { "attribute-name" string }
  67     { "index" integer }
  68 }
  69 { $description "Returns the numeric index of the vertex attribute named " { $snippet "attribute-name" } " in " { $snippet "program-instance" } "." } ;
  70
  71 HELP: <vertex-array>
  72 { $values
  73     { "vertex-buffer" "a " { $link buffer } " or " { $link buffer-ptr } } { "program-instance" program-instance }
  74     { "vertex-array" vertex-array }
  75 }
  76 { $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*> } "." } ;
  77
  78 HELP: <vertex-array*>
  79 { $values
  80     { "vertex-buffer" "a " { $link buffer } " or " { $link buffer-ptr } } { "program-instance" program-instance } { "format" vertex-format }
  81     { "vertex-array" vertex-array }
  82 }
  83 { $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 } "." } ;
  84
  85 { vertex-array <multi-vertex-array> <vertex-array> <vertex-array*> } related-words
  86
  87 HELP: compile-shader-error
  88 { $class-description "An error compiling the source for a " { $link shader } "."
  89 { $list
  90 { "The " { $snippet "shader" } " slot indicates the shader that failed to compile." }
  91 { "The " { $snippet "log" } " slot contains the error string from the GLSL compiler." }
  92 } } ;
  93
  94 HELP: define-vertex-format
  95 { $values
  96     { "class" class } { "vertex-attributes" sequence }
  97 }
  98 { $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." } ;
  99
 100 HELP: define-vertex-struct
 101 { $values
 102     { "class" word } { "vertex-format" vertex-format }
 103 }
 104 { $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." } ;
 105
 106 HELP: fragment-shader
 107 { $class-description "This " { $link shader-kind } " indicates that a " { $link shader } " is a fragment shader." } ;
 108
 109 HELP: link-program-error
 110 { $class-description "An error linking the constituent shaders of a " { $link program } "."
 111 { $list
 112 { "The " { $snippet "program" } " slot indicates the program that failed to link." }
 113 { "The " { $snippet "log" } " slot contains the error string from the GLSL linker." }
 114 } } ;
 115
 116 { compile-shader-error link-program-error } related-words
 117
 118 HELP: output-index
 119 { $values
 120     { "program-instance" program-instance } { "output-name" string }
 121     { "index" integer }
 122 }
 123 { $description "Returns the numeric index of the fragment shader output named " { $snippet "output-name" } " in " { $snippet "program-instance" } "." }
 124 { $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." } ;
 125
 126 HELP: program
 127 { $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> } "." } ;
 128
 129 HELP: program-instance
 130 { $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> } "." } ;
 131
 132 HELP: refresh-program
 133 { $values
 134     { "program" program }
 135 }
 136 { $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." } ;
 137
 138 HELP: shader
 139 { $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> } "." } ;
 140
 141 HELP: shader-instance
 142 { $class-description "A " { $snippet "shader-instance" } " is a " { $link shader } " that has been compiled for a graphics context using " { $link <shader-instance> } "." } ;
 143
 144 HELP: shader-kind
 145 { $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."
 146 { $list
 147 { { $link vertex-shader } "s run during primitive assembly and map input vertex data to positions in screen space for rasterization." }
 148 { { $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." }
 149 } } ;
 150
 151 HELP: too-many-feedback-formats-error
 152 { $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." } ;
 153
 154 HELP: invalid-link-feedback-format-error
 155 { $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 } ")." } ;
 156
 157 HELP: inaccurate-feedback-attribute-error
 158 { $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 } "." } ;
 159
 160 HELP: uniform-index
 161 { $values
 162     { "program-instance" program-instance } { "uniform-name" string }
 163     { "index" integer }
 164 }
 165 { $description "Returns the numeric index of the uniform parameter named " { $snippet "output-name" } " in " { $snippet "program-instance" } "." } ;
 166
 167 HELP: vertex-shader
 168 { $class-description "This " { $link shader-kind } " indicates that a " { $link shader } " is a vertex shader." } ;
 169
 170 HELP: vertex-array
 171 { $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." } ;
 172
 173 HELP: vertex-array-buffers
 174 { $values
 175     { "vertex-array" vertex-array }
 176     { "buffers" sequence }
 177 }
 178 { $description "Returns a sequence containing all of the " { $link buffer } " objects that make up " { $snippet "vertex-array" } "." } ;
 179
 180 HELP: vertex-array-buffer
 181 { $values
 182     { "vertex-array" vertex-array }
 183     { "vertex-buffer" buffer }
 184 }
 185 { $description "Returns the first " { $link buffer } " object that makes up " { $snippet "vertex-array" } "." } ;
 186
 187 { vertex-array-buffer vertex-array-buffers } related-words
 188
 189 HELP: vertex-attribute
 190 { $class-description "This tuple type is passed to " { $link define-vertex-format } " to define a new " { $link vertex-format } " type." } ;
 191
 192 HELP: vertex-format
 193 { $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." } ;
 194
 195 HELP: vertex-format-size
 196 { $values
 197     { "format" vertex-format }
 198     { "size" integer }
 199 }
 200 { $description "Returns the size in bytes of a set of vertex attributes in " { $snippet "format" } "." } ;
 201
 202 ARTICLE: "gpu.shaders" "Shader objects"
 203 "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."
 204 { $subsections
 205     POSTPONE: GLSL-PROGRAM:
 206     POSTPONE: GLSL-SHADER:
 207     POSTPONE: GLSL-SHADER-FILE:
 208 }
 209 "A program must be instantiated for each graphics context it is used in:"
 210 { $subsections <program-instance> }
 211 "Program instances can be updated on the fly, allowing for interactive development of shaders:"
 212 { $subsections refresh-program }
 213 "Render data inside GPU " { $link buffer } "s is organized into " { $link vertex-array } "s for consumption by shader code:"
 214 { $subsections
 215     vertex-array
 216     <multi-vertex-array>
 217     <vertex-array*>
 218     <vertex-array>
 219     POSTPONE: VERTEX-FORMAT:
 220 } ;
 221
 222 ABOUT: "gpu.shaders"