Struct dx::platform::core::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 declarations(&self) -> Option<String>

Returns

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

pub fn hook(&self) -> SnippetHook

Returns

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

pub fn post(&self) -> Option<String>

Returns

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

pub fn pre(&self) -> Option<String>

Returns

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

pub fn replace(&self) -> Option<String>

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 fn 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 fn 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 fn 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 fn 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 Display for Snippet

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

Formats the value using the given formatter.