Struct gsk4::ShaderArgsBuilder

pub struct ShaderArgsBuilder(_);

An object to build the uniforms data for a GLShader.

Implementations

impl ShaderArgsBuilder

pub fn new(
    shader: &GLShader,
    initial_values: Option<&Bytes>
) -> ShaderArgsBuilder

Allocates a builder that can be used to construct a new uniform data chunk.

shader

a GLShader

initial_values

optional GBytes with initial values

Returns

The newly allocated builder, free with Gsk::ShaderArgsBuilder::unref()``

pub fn free_to_args(&self) -> Option<Bytes>

Creates a new GBytes args from the current state of the given self, and frees the self instance.

Any uniforms of the shader that have not been explicitly set on the self are zero-initialized.

Returns

the newly allocated buffer with all the args added to self

pub fn set_bool(&self, idx: i32, value: bool)

Sets the value of the uniform idx.

The uniform must be of bool type.

idx

index of the uniform

value

value to set the uniform to

pub fn set_float(&self, idx: i32, value: f32)

Sets the value of the uniform idx.

The uniform must be of float type.

idx

index of the uniform

value

value to set the uniform to

pub fn set_int(&self, idx: i32, value: i32)

Sets the value of the uniform idx.

The uniform must be of int type.

idx

index of the uniform

value

value to set the uniform to

pub fn set_uint(&self, idx: i32, value: u32)

Sets the value of the uniform idx.

The uniform must be of uint type.

idx

index of the uniform

value

value to set the uniform to

pub fn set_vec2(&self, idx: i32, value: &Vec2)

Sets the value of the uniform idx.

The uniform must be of vec2 type.

idx

index of the uniform

value

value to set the uniform too

pub fn set_vec3(&self, idx: i32, value: &Vec3)

Sets the value of the uniform idx.

The uniform must be of vec3 type.

idx

index of the uniform

value

value to set the uniform too

pub fn set_vec4(&self, idx: i32, value: &Vec4)

Sets the value of the uniform idx.

The uniform must be of vec4 type.

idx

index of the uniform

value

value to set the uniform too

pub fn to_args(&self) -> Option<Bytes>

Creates a new GBytes args from the current state of the given self.

Any uniforms of the shader that have not been explicitly set on the self are zero-initialized.

The given ShaderArgsBuilder is reset once this function returns; you cannot call this function multiple times on the same self instance.

This function is intended primarily for bindings. C code should use free_to_args().

Returns

the newly allocated buffer with all the args added to self

Trait Implementations

impl Clone for ShaderArgsBuilder

fn clone(&self) -> ShaderArgsBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShaderArgsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ShaderArgsBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ShaderArgsBuilder

fn cmp(&self, other: &ShaderArgsBuilder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ShaderArgsBuilder> for ShaderArgsBuilder

fn eq(&self, other: &ShaderArgsBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ShaderArgsBuilder) -> bool

This method tests for !=.

impl PartialOrd<ShaderArgsBuilder> for ShaderArgsBuilder

fn partial_cmp(&self, other: &ShaderArgsBuilder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ShaderArgsBuilder

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ShaderArgsBuilder

impl StructuralEq for ShaderArgsBuilder

impl StructuralPartialEq for ShaderArgsBuilder