pub struct Pipeline(/* private fields */);
Implementations§
Source§impl Pipeline
impl Pipeline
Sourcepub fn add_layer_snippet(&self, layer: i32, snippet: &Snippet)
pub fn add_layer_snippet(&self, layer: i32, snippet: &Snippet)
Adds a shader snippet that will hook on to the given layer of the
pipeline. The exact part of the pipeline that the snippet wraps
around depends on the hook that is given to
Snippet::new
. Note that some hooks can’t be used with a layer
and need to be added with Pipeline::add_snippet
instead.
§layer
The layer to hook the snippet to
§snippet
A Snippet
Sourcepub fn add_snippet(&self, snippet: &Snippet)
pub fn add_snippet(&self, snippet: &Snippet)
Adds a shader snippet to self
. The snippet will wrap around or
replace some part of the pipeline as defined by the hook point in
snippet
. Note that some hook points are specific to a layer and
must be added with Pipeline::add_layer_snippet
instead.
§snippet
The Snippet
to add to the vertex processing hook
Sourcepub fn copy(&self) -> Option<Pipeline>
pub fn copy(&self) -> Option<Pipeline>
Creates a new pipeline with the configuration copied from the source pipeline.
We would strongly advise developers to always aim to use
Pipeline::copy
instead of Pipeline::new
whenever there will
be any similarity between two pipelines. Copying a pipeline helps Cogl
keep track of a pipelines ancestry which we may use to help minimize GPU
state changes.
§Returns
a pointer to the newly allocated Pipeline
Sourcepub fn get_alpha_test_function(&self) -> PipelineAlphaFunc
pub fn get_alpha_test_function(&self) -> PipelineAlphaFunc
§Returns
The alpha test function of self
.
Sourcepub fn get_alpha_test_reference(&self) -> f32
pub fn get_alpha_test_reference(&self) -> f32
§Returns
The alpha test reference value of self
.
Sourcepub fn get_ambient(&self, ambient: &mut Color)
pub fn get_ambient(&self, ambient: &mut Color)
Sourcepub fn get_color_mask(&self) -> ColorMask
pub fn get_color_mask(&self) -> ColorMask
Gets the current ColorMask
of which channels would be written to the
current framebuffer. Each bit set in the mask means that the
corresponding color would be written.
§Returns
A ColorMask
Sourcepub fn get_cull_face_mode(&self) -> PipelineCullFaceMode
pub fn get_cull_face_mode(&self) -> PipelineCullFaceMode
§Returns
the cull face mode that was previously set with
Pipeline::set_cull_face_mode
.
Status: Unstable
Sourcepub fn get_depth_state(&self) -> DepthState
pub fn get_depth_state(&self) -> DepthState
Retrieves the current depth state configuration for the given
self
as previously set using Pipeline::set_depth_state
.
§state_out
A destination DepthState
struct
Sourcepub fn get_diffuse(&self, diffuse: &mut Color)
pub fn get_diffuse(&self, diffuse: &mut Color)
Sourcepub fn get_emission(&self, emission: &mut Color)
pub fn get_emission(&self, emission: &mut Color)
Sourcepub fn get_front_face_winding(&self) -> Winding
pub fn get_front_face_winding(&self) -> Winding
The order of the vertices within a primitive specifies whether it
is considered to be front or back facing. This function specifies
which order is considered to be the front
faces. Winding::CounterClockwise
sets the front faces to
primitives with vertices in a counter-clockwise order and
Winding::Clockwise
sets them to be clockwise. The default is
Winding::CounterClockwise
.
§Returns
The self
front face winding
Status: Unstable
Sourcepub fn get_layer_mag_filter(&self, layer_index: i32) -> PipelineFilter
pub fn get_layer_mag_filter(&self, layer_index: i32) -> PipelineFilter
Retrieves the currently set magnification PipelineFilter
set on
the specified layer. The magnification filter determines how the
layer should be sampled when up-scaled.
The default filter is PipelineFilter::Linear
but this can be
changed using Pipeline::set_layer_filters
.
§layer_index
the layer number to change.
§Returns
The magnification PipelineFilter
for the
specified layer.
Sourcepub fn get_layer_min_filter(&self, layer_index: i32) -> PipelineFilter
pub fn get_layer_min_filter(&self, layer_index: i32) -> PipelineFilter
Retrieves the currently set minification PipelineFilter
set on
the specified layer. The miniifcation filter determines how the
layer should be sampled when down-scaled.
The default filter is PipelineFilter::Linear
but this can be
changed using Pipeline::set_layer_filters
.
§layer_index
the layer number to change.
§Returns
The minification PipelineFilter
for the
specified layer.
Sourcepub fn get_layer_point_sprite_coords_enabled(&self, layer_index: i32) -> bool
pub fn get_layer_point_sprite_coords_enabled(&self, layer_index: i32) -> bool
Sourcepub fn get_layer_texture(&self, layer_index: i32) -> Option<Texture>
pub fn get_layer_texture(&self, layer_index: i32) -> Option<Texture>
Sourcepub fn get_layer_wrap_mode_p(&self, layer_index: i32) -> PipelineWrapMode
pub fn get_layer_wrap_mode_p(&self, layer_index: i32) -> PipelineWrapMode
Sourcepub fn get_layer_wrap_mode_s(&self, layer_index: i32) -> PipelineWrapMode
pub fn get_layer_wrap_mode_s(&self, layer_index: i32) -> PipelineWrapMode
Sourcepub fn get_layer_wrap_mode_t(&self, layer_index: i32) -> PipelineWrapMode
pub fn get_layer_wrap_mode_t(&self, layer_index: i32) -> PipelineWrapMode
Sourcepub fn get_n_layers(&self) -> i32
pub fn get_n_layers(&self) -> i32
Sourcepub fn get_per_vertex_point_size(&self) -> bool
pub fn get_per_vertex_point_size(&self) -> bool
§Returns
true
if the pipeline has per-vertex point size
enabled or false
otherwise. The per-vertex point size can be
enabled with Pipeline::set_per_vertex_point_size
.
Sourcepub fn get_point_size(&self) -> f32
pub fn get_point_size(&self) -> f32
Get the size of points drawn when VerticesMode::Points
is
used with the vertex buffer API.
§Returns
the point size of the self
.
Sourcepub fn get_shininess(&self) -> f32
pub fn get_shininess(&self) -> f32
Sourcepub fn get_specular(&self, specular: &mut Color)
pub fn get_specular(&self, specular: &mut Color)
Sourcepub fn get_uniform_location(&self, uniform_name: &str) -> i32
pub fn get_uniform_location(&self, uniform_name: &str) -> i32
This is used to get an integer representing the uniform with the
name uniform_name
. The integer can be passed to functions such as
Pipeline::set_uniform_1f
to set the value of a uniform.
This function will always return a valid integer. Ie, unlike OpenGL, it does not return -1 if the uniform is not available in this pipeline so it can not be used to test whether uniforms are present. It is not necessary to set the program on the pipeline before calling this function.
§uniform_name
The name of a uniform
§Returns
A integer representing the location of the given uniform.
Sourcepub fn remove_layer(&self, layer_index: i32)
pub fn remove_layer(&self, layer_index: i32)
This function removes a layer from your pipeline
§layer_index
Specifies the layer you want to remove
Sourcepub fn set_alpha_test_function(
&self,
alpha_func: PipelineAlphaFunc,
alpha_reference: f32,
)
pub fn set_alpha_test_function( &self, alpha_func: PipelineAlphaFunc, alpha_reference: f32, )
Before a primitive is blended with the framebuffer, it goes through an alpha test stage which lets you discard fragments based on the current alpha value. This function lets you change the function used to evaluate the alpha channel, and thus determine which fragments are discarded and which continue on to the blending stage.
The default is PipelineAlphaFunc::Always
§alpha_func
A PipelineAlphaFunc
constant
§alpha_reference
A reference point that the chosen alpha function uses to compare incoming fragments to.
Sourcepub fn set_ambient(&self, ambient: &Color)
pub fn set_ambient(&self, ambient: &Color)
Sets the pipeline’s ambient color, in the standard OpenGL lighting model. The ambient color affects the overall color of the object.
Since the diffuse color will be intense when the light hits the surface directly, the ambient will be most apparent where the light hits at a slant.
The default value is (0.2, 0.2, 0.2, 1.0)
§ambient
The components of the desired ambient color
Sourcepub fn set_ambient_and_diffuse(&self, color: &Color)
pub fn set_ambient_and_diffuse(&self, color: &Color)
Conveniently sets the diffuse and ambient color of self
at the same
time. See Pipeline::set_ambient
and Pipeline::set_diffuse
.
The default ambient color is (0.2, 0.2, 0.2, 1.0)
The default diffuse color is (0.8, 0.8, 0.8, 1.0)
§color
The components of the desired ambient and diffuse colors
Sourcepub fn set_blend(&self, blend_string: &str) -> Result<bool, Error>
pub fn set_blend(&self, blend_string: &str) -> Result<bool, Error>
If not already familiar; please refer here</link>
for an overview of what blend strings are, and their syntax.
Blending occurs after the alpha test function, and combines fragments with the framebuffer.
Currently the only blend function Cogl exposes is ADD(). So any valid blend statements will be of the form:
<channel-mask>=ADD(SRC_COLOR*(<factor>), DST_COLOR*(<factor>))
This is the list of source-names usable as blend factors:
<itemizedlist>
<listitem>``<para>
SRC_COLOR: The color of the in comming fragment</para>``</listitem>
<listitem>``<para>
DST_COLOR: The color of the framebuffer</para>``</listitem>
<listitem>``<para>
CONSTANT: The constant set via Pipeline::set_blend_constant``</para>``</listitem>
</itemizedlist>
The source names can be used according to the
color-source and factor syntax``, so for example "(1-SRC_COLOR[A])" would be a valid factor, as would "(CONSTANT[RGB])"These can also be used as factors:
<itemizedlist>
<listitem>
0: (0, 0, 0, 0)</listitem>
<listitem>
1: (1, 1, 1, 1)</listitem>
<listitem>
SRC_ALPHA_SATURATE_FACTOR: (f,f,f,1) where f = MIN(SRC_COLOR[A],1-DST_COLOR[A])</listitem>
</itemizedlist>
<note>
Remember; all color components are normalized to the range [0, 1]
before computing the result of blending.</note>
The default blend string is:
RGBA = ADD (SRC_COLOR, DST_COLOR*(1-SRC_COLOR[A]))
That gives normal alpha-blending when the calculated color for the pipeline is in premultiplied form.
§blend_string
A Cogl blend string</link>
describing the desired blend function.
§Returns
true
if the blend string was successfully parsed, and the
described blending is supported by the underlying driver/hardware. If
there was an error, false
is returned and error
is set accordingly (if
present).
Sourcepub fn set_blend_constant(&self, constant_color: &Color)
pub fn set_blend_constant(&self, constant_color: &Color)
When blending is setup to reference a CONSTANT blend factor then blending will depend on the constant set with this function.
§constant_color
The constant color you want
Sourcepub fn set_color(&self, color: &Color)
pub fn set_color(&self, color: &Color)
Sets the basic color of the pipeline, used when no lighting is enabled.
Note that if you don’t add any layers to the pipeline then the color
will be blended unmodified with the destination; the default blend
expects premultiplied colors: for example, use (0.5, 0.0, 0.0, 0.5) for
semi-transparent red. See Color::premultiply
.
The default value is (1.0, 1.0, 1.0, 1.0)
§color
The components of the color
Sourcepub fn set_color_mask(&self, color_mask: ColorMask)
pub fn set_color_mask(&self, color_mask: ColorMask)
Defines a bit mask of which color channels should be written to the
current framebuffer. If a bit is set in color_mask
that means that
color will be written.
§color_mask
A ColorMask
of which color channels to write to
the current framebuffer.
Sourcepub fn set_cull_face_mode(&self, cull_face_mode: PipelineCullFaceMode)
pub fn set_cull_face_mode(&self, cull_face_mode: PipelineCullFaceMode)
Sets which faces will be culled when drawing. Face culling can be
used to increase efficiency by avoiding drawing faces that would
get overridden. For example, if a model has gaps so that it is
impossible to see the inside then faces which are facing away from
the screen will never be seen so there is no point in drawing
them. This can be acheived by setting the cull face mode to
PipelineCullFaceMode::Back
.
Face culling relies on the primitives being drawn with a specific
order to represent which faces are facing inside and outside the
model. This order can be specified by calling
Pipeline::set_front_face_winding
.
Status: Unstable
§cull_face_mode
The new mode to set
Sourcepub fn set_depth_state(&self, state: &DepthState) -> Result<bool, Error>
pub fn set_depth_state(&self, state: &DepthState) -> Result<bool, Error>
This commits all the depth state configured in state
struct to the
given self
. The configuration values are copied into the
pipeline so there is no requirement to keep the DepthState
struct around if you don’t need it any more.
Note: Since some platforms do not support the depth range feature
it is possible for this function to fail and report an error
.
§state
A DepthState
struct
§Returns
TRUE if the GPU supports all the given state
else false
and returns an error
.
Sourcepub fn set_diffuse(&self, diffuse: &Color)
pub fn set_diffuse(&self, diffuse: &Color)
Sets the pipeline’s diffuse color, in the standard OpenGL lighting model. The diffuse color is most intense where the light hits the surface directly - perpendicular to the surface.
The default value is (0.8, 0.8, 0.8, 1.0)
§diffuse
The components of the desired diffuse color
Sourcepub fn set_emission(&self, emission: &Color)
pub fn set_emission(&self, emission: &Color)
Sets the pipeline’s emissive color, in the standard OpenGL lighting model. It will look like the surface is a light source emitting this color.
The default value is (0.0, 0.0, 0.0, 1.0)
§emission
The components of the desired emissive color
Sourcepub fn set_front_face_winding(&self, front_winding: Winding)
pub fn set_front_face_winding(&self, front_winding: Winding)
The order of the vertices within a primitive specifies whether it
is considered to be front or back facing. This function specifies
which order is considered to be the front
faces. Winding::CounterClockwise
sets the front faces to
primitives with vertices in a counter-clockwise order and
Winding::Clockwise
sets them to be clockwise. The default is
Winding::CounterClockwise
.
Status: Unstable
§front_winding
the winding order
Sourcepub fn set_layer_combine(
&self,
layer_index: i32,
blend_string: &str,
) -> Result<bool, Error>
pub fn set_layer_combine( &self, layer_index: i32, blend_string: &str, ) -> Result<bool, Error>
If not already familiar; you can refer
here`` for an overview of what blend strings are and there syntax.These are all the functions available for texture combining:
<itemizedlist>
<listitem>
REPLACE(arg0) = arg0</listitem>
<listitem>
MODULATE(arg0, arg1) = arg0 x arg1</listitem>
<listitem>
ADD(arg0, arg1) = arg0 + arg1</listitem>
<listitem>
ADD_SIGNED(arg0, arg1) = arg0 + arg1 - 0.5</listitem>
<listitem>
INTERPOLATE(arg0, arg1, arg2) = arg0 x arg2 + arg1 x (1 - arg2)</listitem>
<listitem>
SUBTRACT(arg0, arg1) = arg0 - arg1</listitem>
<listitem>
<programlisting>
DOT3_RGB(arg0, arg1) = 4 x ((arg0[R] - 0.5)) * (arg1[R] - 0.5) +
(arg0[G] - 0.5)) * (arg1[G] - 0.5) +
(arg0[B] - 0.5)) * (arg1[B] - 0.5))
</programlisting>
</listitem>
<listitem>
<programlisting>
DOT3_RGBA(arg0, arg1) = 4 x ((arg0[R] - 0.5)) * (arg1[R] - 0.5) +
(arg0[G] - 0.5)) * (arg1[G] - 0.5) +
(arg0[B] - 0.5)) * (arg1[B] - 0.5))
</programlisting>
</listitem>
</itemizedlist>
Refer to the
color-source syntax`` for describing the arguments. The valid source names for texture combining are: `<note>
You can’t give a multiplication factor for arguments as you can
with blending.</note>
§layer_index
Specifies the layer you want define a combine function for
§blend_string
A Cogl blend string</link>
describing the desired texture combine function.
§Returns
true
if the blend string was successfully parsed, and the
described texture combining is supported by the underlying driver and
or hardware. On failure, false
is returned and error
is set
Sourcepub fn set_layer_combine_constant(&self, layer_index: i32, constant: &Color)
pub fn set_layer_combine_constant(&self, layer_index: i32, constant: &Color)
Sourcepub fn set_layer_filters(
&self,
layer_index: i32,
min_filter: PipelineFilter,
mag_filter: PipelineFilter,
)
pub fn set_layer_filters( &self, layer_index: i32, min_filter: PipelineFilter, mag_filter: PipelineFilter, )
Changes the decimation and interpolation filters used when a texture is drawn at other scales than 100%.
<note>
It is an error to pass anything other than
PipelineFilter::Nearest
or PipelineFilter::Linear
as
magnification filters since magnification doesn’t ever need to
reference values stored in the mipmap chain.</note>
§layer_index
the layer number to change.
§min_filter
the filter used when scaling a texture down.
§mag_filter
the filter used when magnifying a texture.
Sourcepub fn set_layer_matrix(&self, layer_index: i32, matrix: &Matrix)
pub fn set_layer_matrix(&self, layer_index: i32, matrix: &Matrix)
Sourcepub fn set_layer_null_texture(
&self,
layer_index: i32,
texture_type: TextureType,
)
pub fn set_layer_null_texture( &self, layer_index: i32, texture_type: TextureType, )
Sets the texture for this layer to be the default texture for the
given type. This is equivalent to calling
Pipeline::set_layer_texture
with None
for the texture
argument except that you can also specify the type of default
texture to use. The default texture is a 1x1 pixel white texture.
This function is mostly useful if you want to create a base
pipeline that you want to create multiple copies from using
Pipeline::copy
. In that case this function can be used to
specify the texture type so that any pipeline copies can share the
internal texture type state for efficiency.
§layer_index
The layer number to modify
§texture_type
The type of the default texture to use
Sourcepub fn set_layer_point_sprite_coords_enabled(
&self,
layer_index: i32,
enable: bool,
) -> Result<bool, Error>
pub fn set_layer_point_sprite_coords_enabled( &self, layer_index: i32, enable: bool, ) -> Result<bool, Error>
When rendering points, if enable
is true
then the texture
coordinates for this layer will be replaced with coordinates that
vary from 0.0 to 1.0 across the primitive. The top left of the
point will have the coordinates 0.0,0.0 and the bottom right will
have 1.0,1.0. If enable
is false
then the coordinates will be
fixed for the entire point.
This function will only work if FeatureID::OglFeatureIdPointSprite
is
available. If the feature is not available then the function will
return false
and set error
.
§layer_index
the layer number to change.
§enable
whether to enable point sprite coord generation.
§Returns
true
if the function succeeds, false
otherwise.
pub fn set_layer_texture<P: IsA<Texture>>(&self, layer_index: i32, texture: &P)
Sourcepub fn set_layer_wrap_mode(&self, layer_index: i32, mode: PipelineWrapMode)
pub fn set_layer_wrap_mode(&self, layer_index: i32, mode: PipelineWrapMode)
Sourcepub fn set_layer_wrap_mode_p(&self, layer_index: i32, mode: PipelineWrapMode)
pub fn set_layer_wrap_mode_p(&self, layer_index: i32, mode: PipelineWrapMode)
Sourcepub fn set_layer_wrap_mode_s(&self, layer_index: i32, mode: PipelineWrapMode)
pub fn set_layer_wrap_mode_s(&self, layer_index: i32, mode: PipelineWrapMode)
Sourcepub fn set_layer_wrap_mode_t(&self, layer_index: i32, mode: PipelineWrapMode)
pub fn set_layer_wrap_mode_t(&self, layer_index: i32, mode: PipelineWrapMode)
Sourcepub fn set_per_vertex_point_size(&self, enable: bool) -> Result<bool, Error>
pub fn set_per_vertex_point_size(&self, enable: bool) -> Result<bool, Error>
Sets whether to use a per-vertex point size or to use the value set
by Pipeline::set_point_size
. If per-vertex point size is
enabled then the point size can be set for an individual point
either by drawing with a Attribute
with the name
‘cogl_point_size_in’ or by writing to the GLSL builtin
‘cogl_point_size_out’ from a vertex shader snippet.
If per-vertex point size is enabled and this attribute is not used and cogl_point_size_out is not written to then the results are undefined.
Note that enabling this will only work if the
FeatureID::OglFeatureIdPerVertexPointSize
feature is available. If
this is not available then the function will return false
and set
a CoglError
.
§enable
whether to enable per-vertex point size
§Returns
true
if the change suceeded or false
otherwise
Sourcepub fn set_point_size(&self, point_size: f32)
pub fn set_point_size(&self, point_size: f32)
Changes the size of points drawn when VerticesMode::Points
is
used with the attribute buffer API. Note that typically the GPU
will only support a limited minimum and maximum range of point
sizes. If the chosen point size is outside that range then the
nearest value within that range will be used instead. The size of a
point is in screen space so it will be the same regardless of any
transformations.
If the point size is set to 0.0 then drawing points with the pipeline will have undefined results. This is the default value so if an application wants to draw points it must make sure to use a pipeline that has an explicit point size set on it.
§point_size
the new point size.
Sourcepub fn set_shininess(&self, shininess: f32)
pub fn set_shininess(&self, shininess: f32)
Sets the shininess of the pipeline, in the standard OpenGL lighting
model, which determines the size of the specular highlights. A
higher shininess
will produce smaller highlights which makes the
object appear more shiny.
The default value is 0.0
§shininess
The desired shininess; must be >= 0.0
Sourcepub fn set_specular(&self, specular: &Color)
pub fn set_specular(&self, specular: &Color)
Sets the pipeline’s specular color, in the standard OpenGL lighting model. The intensity of the specular color depends on the viewport position, and is brightest along the lines of reflection.
The default value is (0.0, 0.0, 0.0, 1.0)
§specular
The components of the desired specular color
Sourcepub fn set_uniform_1f(&self, uniform_location: i32, value: f32)
pub fn set_uniform_1f(&self, uniform_location: i32, value: f32)
Sets a new value for the uniform at uniform_location
. If this
pipeline has a user program attached and is later used as a source
for drawing, the given value will be assigned to the uniform which
can be accessed from the shader’s source. The value for
uniform_location
should be retrieved from the string name of the
uniform by calling Pipeline::get_uniform_location
.
This function should be used to set uniforms that are of type float. It can also be used to set a single member of a float array uniform.
§uniform_location
The uniform’s location identifier
§value
The new value for the uniform
Sourcepub fn set_uniform_1i(&self, uniform_location: i32, value: i32)
pub fn set_uniform_1i(&self, uniform_location: i32, value: i32)
Sets a new value for the uniform at uniform_location
. If this
pipeline has a user program attached and is later used as a source
for drawing, the given value will be assigned to the uniform which
can be accessed from the shader’s source. The value for
uniform_location
should be retrieved from the string name of the
uniform by calling Pipeline::get_uniform_location
.
This function should be used to set uniforms that are of type int. It can also be used to set a single member of a int array uniform or a sampler uniform.
§uniform_location
The uniform’s location identifier
§value
The new value for the uniform
Sourcepub fn set_uniform_float(
&self,
uniform_location: i32,
n_components: i32,
count: i32,
value: &[f32],
)
pub fn set_uniform_float( &self, uniform_location: i32, n_components: i32, count: i32, value: &[f32], )
Sets new values for the uniform at uniform_location
. If this
pipeline has a user program attached and is later used as a source
for drawing, the given values will be assigned to the uniform which
can be accessed from the shader’s source. The value for
uniform_location
should be retrieved from the string name of the
uniform by calling Pipeline::get_uniform_location
.
This function can be used to set any floating point type uniform,
including float arrays and float vectors. For example, to set a
single vec4 uniform you would use 4 for n_components
and 1 for
count
. To set an array of 8 float values, you could use 1 for
n_components
and 8 for count
.
§uniform_location
The uniform’s location identifier
§n_components
The number of components in the corresponding uniform’s type
§count
The number of values to set
§value
Pointer to the new values to set
Sourcepub fn set_uniform_int(
&self,
uniform_location: i32,
n_components: i32,
count: i32,
value: &[i32],
)
pub fn set_uniform_int( &self, uniform_location: i32, n_components: i32, count: i32, value: &[i32], )
Sets new values for the uniform at uniform_location
. If this
pipeline has a user program attached and is later used as a source
for drawing, the given values will be assigned to the uniform which
can be accessed from the shader’s source. The value for
uniform_location
should be retrieved from the string name of the
uniform by calling Pipeline::get_uniform_location
.
This function can be used to set any integer type uniform,
including int arrays and int vectors. For example, to set a single
ivec4 uniform you would use 4 for n_components
and 1 for
count
. To set an array of 8 int values, you could use 1 for
n_components
and 8 for count
.
§uniform_location
The uniform’s location identifier
§n_components
The number of components in the corresponding uniform’s type
§count
The number of values to set
§value
Pointer to the new values to set
Sourcepub fn set_uniform_matrix(
&self,
uniform_location: i32,
dimensions: i32,
count: i32,
transpose: bool,
value: &[f32],
)
pub fn set_uniform_matrix( &self, uniform_location: i32, dimensions: i32, count: i32, transpose: bool, value: &[f32], )
Sets new values for the uniform at uniform_location
. If this
pipeline has a user program attached and is later used as a source
for drawing, the given values will be assigned to the uniform which
can be accessed from the shader’s source. The value for
uniform_location
should be retrieved from the string name of the
uniform by calling Pipeline::get_uniform_location
.
This function can be used to set any matrix type uniform, including
matrix arrays. For example, to set a single mat4 uniform you would
use 4 for dimensions
and 1 for count
. To set an array of 8
mat3 values, you could use 3 for dimensions
and 8 for count
.
If transpose
is false
then the matrix is expected to be in
column-major order or if it is true
then the matrix is in
row-major order. You can pass a Matrix
by calling by passing
the result of Matrix::get_array
in value
and setting
transpose
to false
.
§uniform_location
The uniform’s location identifier
§dimensions
The size of the matrix
§count
The number of values to set
§transpose
Whether to transpose the matrix
§value
Pointer to the new values to set
Trait Implementations§
Source§impl Ord for Pipeline
impl Ord for Pipeline
Source§impl<T: ObjectType> PartialEq<T> for Pipeline
impl<T: ObjectType> PartialEq<T> for Pipeline
Source§impl<T: ObjectType> PartialOrd<T> for Pipeline
impl<T: ObjectType> PartialOrd<T> for Pipeline
Source§impl StaticType for Pipeline
impl StaticType for Pipeline
Source§fn static_type() -> Type
fn static_type() -> Type
Self
.impl Eq for Pipeline
impl IsA<Object> for Pipeline
Auto Trait Implementations§
impl Freeze for Pipeline
impl RefUnwindSafe for Pipeline
impl !Send for Pipeline
impl !Sync for Pipeline
impl Unpin for Pipeline
impl UnwindSafe for Pipeline
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Cast for Twhere
T: ObjectType,
impl<T> Cast for Twhere
T: ObjectType,
Source§fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
T
. Read moreSource§fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
T
. Read moreSource§fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: CanDowncast<T>,
T
. Read moreSource§fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<T>,
T
. Read moreSource§fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read moreSource§fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read moreSource§unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
T
unconditionally. Read moreSource§unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
&T
unconditionally. Read moreSource§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
Source§impl<T> ObjectExt for Twhere
T: ObjectType,
impl<T> ObjectExt for Twhere
T: ObjectType,
Source§fn is<U>(&self) -> boolwhere
U: StaticType,
fn is<U>(&self) -> boolwhere
U: StaticType,
true
if the object is an instance of (can be cast to) T
.