Struct Snippet

pub struct Snippet(/* private fields */);

Implementations

impl Snippet

pub fn new(hook: SnippetHook, declarations: &str, post: &str) -> Snippet

Allocates and initializes a new snippet with the given source strings.

hook

The point in the pipeline that this snippet will wrap around or replace.

declarations

The source code for the declarations for this snippet or None. See Snippet::set_declarations.

post

The source code to run after the hook point where this shader snippet is attached or None. See Snippet::set_post.

Returns

a pointer to a new Snippet

pub fn get_declarations(&self) -> Option<GString>

Returns

the source string that was set with Snippet::set_declarations or None if none was set.

pub fn get_hook(&self) -> SnippetHook

Returns

the hook that was set when Snippet::new was called.

pub fn get_post(&self) -> Option<GString>

Returns

the source string that was set with Snippet::set_post or None if none was set.

pub fn get_pre(&self) -> Option<GString>

Returns

the source string that was set with Snippet::set_pre or None if none was set.

pub fn get_replace(&self) -> Option<GString>

Returns

the source string that was set with Snippet::set_replace or None if none was set.

pub fn set_declarations(&self, declarations: &str)

Sets a source string that will be inserted in the global scope of the generated shader when this snippet is used on a pipeline. This string is typically used to declare uniforms, attributes or functions that will be used by the other parts of the snippets.

This function should only be called before the snippet is attached to its first pipeline. After that the snippet should be considered immutable.

declarations

The new source string for the declarations section of this snippet.

pub fn set_post(&self, post: &str)

Sets a source string that will be inserted after the hook point in the generated shader for the pipeline that this snippet is attached to. Please see the documentation of each hook point in Pipeline for a description of how this string should be used.

This function should only be called before the snippet is attached to its first pipeline. After that the snippet should be considered immutable.

post

The new source string for the post section of this snippet.

pub fn set_pre(&self, pre: &str)

Sets a source string that will be inserted before the hook point in the generated shader for the pipeline that this snippet is attached to. Please see the documentation of each hook point in Pipeline for a description of how this string should be used.

This function should only be called before the snippet is attached to its first pipeline. After that the snippet should be considered immutable.

pre

The new source string for the pre section of this snippet.

pub fn set_replace(&self, replace: &str)

Sets a source string that will be used instead of any generated source code or any previous snippets for this hook point. Please see the documentation of each hook point in Pipeline for a description of how this string should be used.

This function should only be called before the snippet is attached to its first pipeline. After that the snippet should be considered immutable.

replace

The new source string for the replace section of this snippet.

Trait Implementations

impl Clone for Snippet

fn clone(&self) -> Snippet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Snippet

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

Formats the value using the given formatter.

impl Display for Snippet

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

Formats the value using the given formatter.

impl Hash for Snippet

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Snippet

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Snippet

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Snippet

impl IsA<Object> for Snippet