mutter/doc/reference/cogl-2.0-experimental
Neil Roberts 4553ca0695 cogl-pipeline: Add support for setting uniform values
This adds the following new public experimental functions to set
uniform values on a CoglPipeline:

void
cogl_pipeline_set_uniform_1f (CoglPipeline *pipeline,
                              int uniform_location,
                              float value);
void
cogl_pipeline_set_uniform_1i (CoglPipeline *pipeline,
                              int uniform_location,
                              int value);
void
cogl_pipeline_set_uniform_float (CoglPipeline *pipeline,
                                 int uniform_location,
                                 int n_components,
                                 int count,
                                 const float *value);
void
cogl_pipeline_set_uniform_int (CoglPipeline *pipeline,
                               int uniform_location,
                               int n_components,
                               int count,
                               const int *value);
void
cogl_pipeline_set_uniform_matrix (CoglPipeline *pipeline,
                                  int uniform_location,
                                  int dimensions,
                                  int count,
                                  gboolean transpose,
                                  const float *value);

These are similar to the old functions used to set uniforms on a
CoglProgram. To get a value to pass in as the uniform_location there
is also:

int
cogl_pipeline_get_uniform_location (CoglPipeline *pipeline,
                                    const char *uniform_name);

Conceptually the uniform locations are tied to the pipeline so that
whenever setting a value for a new pipeline the application is
expected to call this function. However in practice the uniform
locations are global to the CoglContext. The names are stored in a
linked list where the position in the list is the uniform location.

The global indices are used so that each pipeline can store a mask of
which uniforms it overrides. That way it is quicker to detect which
uniforms are different from the last pipeline that used the same
CoglProgramState so it can avoid flushing uniforms that haven't
changed. Currently the values are not actually compared which means
that it will only avoid flushing a uniform if there is a common
ancestor that sets the value (or if the same pipeline is being flushed
again - in which case the pipeline and its common ancestor are the
same thing).

The uniform values are stored in the big state of the pipeline as a
sparse linked list. A bitmask stores which values have been overridden
and only overridden values are stored in the linked list.

Reviewed-by: Robert Bragg <robert@linux.intel.com>
2011-11-16 16:32:11 +00:00
..
blend-strings.xml Make it clearer that the 2.0 API is experimental 2011-06-14 17:09:55 +01:00
cogl_ortho.png Make it clearer that the 2.0 API is experimental 2011-06-14 17:09:55 +01:00
cogl-2.0-experimental-docs.xml.in docs: Adds various missing 2.0 sections and symbols 2011-11-01 12:03:04 +00:00
cogl-2.0-experimental-sections.txt cogl-pipeline: Add support for setting uniform values 2011-11-16 16:32:11 +00:00
fill-rule-even-odd.png Make it clearer that the 2.0 API is experimental 2011-06-14 17:09:55 +01:00
fill-rule-non-zero.png Make it clearer that the 2.0 API is experimental 2011-06-14 17:09:55 +01:00
Makefile.am docs: Adds various missing 2.0 sections and symbols 2011-11-01 12:03:04 +00:00
quad-indices-order.png Make it clearer that the 2.0 API is experimental 2011-06-14 17:09:55 +01:00
quad-indices-triangles.png Make it clearer that the 2.0 API is experimental 2011-06-14 17:09:55 +01:00