Struct gstreamer_gl::GLShader

pub struct GLShader(_, _);

Implements

gst::ObjectExt, glib::object::ObjectExt

Methods

impl GLShader

pub fn new<P: IsA<GLContext>>(context: &P) -> GLShader

Note: must be called in the GL thread

context

a GLContext

Returns

a new empty shader

pub fn new_default<P: IsA<GLContext>>(context: &P) -> Result<GLShader, Error>

Note: must be called in the GL thread

context

a GLContext

Returns

a default shader or None on failure

pub fn attach(&self, stage: &GLSLStage) -> Result<(), BoolError>

Attaches stage to self. stage must have been successfully compiled with GLSLStage::compile.

Note: must be called in the GL thread

stage

a GLSLStage to attach

Returns

whether stage could be attached to self

pub fn attach_unlocked(&self, stage: &GLSLStage) -> Result<(), BoolError>

Attaches stage to self. stage must have been successfully compiled with GLSLStage::compile.

Note: must be called in the GL thread

stage

a GLSLStage to attach

Returns

whether stage could be attached to self

pub fn bind_attribute_location(&self, index: u32, name: &str)

Bind attribute name to the specified location index using glBindAttributeLocation().

index

attribute index to set

name

name of the attribute

pub fn bind_frag_data_location(&self, index: u32, name: &str)

Bind attribute name to the specified location index using glBindFragDataLocation().

index

attribute index to set

name

name of the attribute

pub fn compile_attach_stage(&self, stage: &GLSLStage) -> Result<(), Error>

Compiles stage and attaches it to self.

Note: must be called in the GL thread

stage

a GLSLStage to attach

Returns

whether stage could be compiled and attached to self

pub fn detach(&self, stage: &GLSLStage)

Detaches stage from self. stage must have been successfully attached to self with GLShader::attach or GLShader::attach_unlocked.

Note: must be called in the GL thread

stage

a GLSLStage to attach

pub fn detach_unlocked(&self, stage: &GLSLStage)

Detaches stage from self. stage must have been successfully attached to self with GLShader::attach or GLShader::attach_unlocked.

Note: must be called in the GL thread

stage

a GLSLStage to attach

pub fn get_attribute_location(&self, name: &str) -> i32

name

name of the attribute

Returns

the attribute index for name in self or -1 on failure

pub fn get_program_handle(&self) -> i32

Returns

the GL program handle for this shader

pub fn is_linked(&self) -> bool

Note: must be called in the GL thread

Returns

whether self has been successfully linked

pub fn link(&self) -> Result<(), Error>

Links the current list of GLSLStage's in self.

Note: must be called in the GL thread

Returns

whether self could be linked together.

pub fn release(&self)

Releases the shader and stages.

Note: must be called in the GL thread

pub fn release_unlocked(&self)

Releases the shader and stages.

Note: must be called in the GL thread

pub fn set_uniform_1f(&self, name: &str, value: f32)

Perform glUniform1f() for name on self

name

name of the uniform

value

value to set

pub fn set_uniform_1fv(&self, name: &str, value: &[f32])

Perform glUniform1fv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn set_uniform_1i(&self, name: &str, value: i32)

Perform glUniform1i() for name on self

name

name of the uniform

value

value to set

pub fn set_uniform_1iv(&self, name: &str, value: &[i32])

Perform glUniform1iv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn set_uniform_2f(&self, name: &str, v0: f32, v1: f32)

Perform glUniform2f() for name on self

name

name of the uniform

v0

first value to set

v1

second value to set

pub fn set_uniform_2fv(&self, name: &str, value: &[f32])

Perform glUniform2fv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn set_uniform_2i(&self, name: &str, v0: i32, v1: i32)

Perform glUniform2i() for name on self

name

name of the uniform

v0

first value to set

v1

second value to set

pub fn set_uniform_2iv(&self, name: &str, value: &[i32])

Perform glUniform2iv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn set_uniform_3f(&self, name: &str, v0: f32, v1: f32, v2: f32)

Perform glUniform3f() for name on self

name

name of the uniform

v0

first value to set

v1

second value to set

v2

third value to set

pub fn set_uniform_3fv(&self, name: &str, value: &[f32])

Perform glUniform3fv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn set_uniform_3i(&self, name: &str, v0: i32, v1: i32, v2: i32)

Perform glUniform3i() for name on self

name

name of the uniform

v0

first value to set

v1

second value to set

v2

third value to set

pub fn set_uniform_3iv(&self, name: &str, value: &[i32])

Perform glUniform3iv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn set_uniform_4f(&self, name: &str, v0: f32, v1: f32, v2: f32, v3: f32)

Perform glUniform4f() for name on self

name

name of the uniform

v0

first value to set

v1

second value to set

v2

third value to set

v3

fourth value to set

pub fn set_uniform_4fv(&self, name: &str, value: &[f32])

Perform glUniform4fv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn set_uniform_4i(&self, name: &str, v0: i32, v1: i32, v2: i32, v3: i32)

Perform glUniform4i() for name on self

name

name of the uniform

v0

first value to set

v1

second value to set

v2

third value to set

v3

fourth value to set

pub fn set_uniform_4iv(&self, name: &str, value: &[i32])

Perform glUniform4iv() for name on self

name

name of the uniform

count

number of values to set

value

values to set

pub fn use_(&self)

pub fn get_property_linked(&self) -> bool

pub fn string_fragment_external_oes_get_default<P: IsA<GLContext>>(
    context: &P,
    version: GLSLVersion,
    profile: GLSLProfile
) -> Option<GString>

Feature: v1_16

context

a GLContext

version

a GLSLVersion

profile

a GLSLProfile

Returns

a passthrough shader string for copying an input external-oes texture to the output

pub fn string_fragment_get_default<P: IsA<GLContext>>(
    context: &P,
    version: GLSLVersion,
    profile: GLSLProfile
) -> Option<GString>

Feature: v1_16

context

a GLContext

version

a GLSLVersion

profile

a GLSLProfile

Returns

a passthrough shader string for copying an input texture to the output

pub fn string_get_highest_precision<P: IsA<GLContext>>(
    context: &P,
    version: GLSLVersion,
    profile: GLSLProfile
) -> Option<GString>

Generates a shader string that defines the precision of float types in GLSL shaders. This is particularly needed for fragment shaders in a GLSL ES context where there is no default precision specified.

Practically, this will return the string 'precision mediump float' or 'precision highp float' depending on if high precision floats are determined to be supported.

Feature: v1_16

context

a GLContext

version

a GLSLVersion

profile

a GLSLProfile

Returns

a shader string defining the precision of float types based on context, version and profile

pub fn connect_property_linked_notify<F: Fn(&GLShader) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for GLShader

fn clone(&self) -> GLShader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GLShader

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

Formats the value using the given formatter.

impl Eq for GLShader

impl Hash for GLShader

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 IsA<Object> for GLShader

impl Ord for GLShader

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for GLShader

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for GLShader

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Send for GLShader

impl StaticType for GLShader

fn static_type() -> Type

Returns the type identifier of Self.

impl Sync for GLShader