Struct ssbh_lib::formats::nufx::ShaderProgram

pub struct ShaderProgram {
    pub name: SsbhString8,
    pub render_pass: SsbhString,
    pub shaders: ShaderStages,
    pub vertex_attributes: Option<SsbhArray<VertexAttribute>>,
    pub material_parameters: SsbhArray<MaterialParameter>,
}

Describes the name and associated information for a set of compiled shaders linked into a program. Each ShaderProgram has a corresponding shader program object in the underlying rendering API such as OpenGL, Vulkan, etc.

Fields

name: SsbhString8

The unique identifier of the shader program, including its render_pass.

render_pass: SsbhString

Programs are grouped into passes to determine the render order. Possible values for Smash Ultimate are “nu::Final”, “nu::Opaque”, “nu::Sort”, “nu::Near”, and “nu::Far”.

shaders: ShaderStages

The shaders to compile and link for this program.

vertex_attributes: Option<SsbhArray<VertexAttribute>>

The required inputs to the vertex shader. This information was added after version 1.0.

material_parameters: SsbhArray<MaterialParameter>

The required parameters from the Matl materials.

Trait Implementations

impl BinRead for ShaderProgram

type Args = (u16, u16)

The type of arguments needed to be supplied in order to read this type, usually a tuple.

fn read_options<R: Read + Seek>(
    __binread_generated_var_reader: &mut R,
    __binread_generated_var_options: &ReadOptions,
    __binread_generated_var_arguments: Self::Args
) -> BinResult<Self>

Read the type from the reader

fn read<R>(reader: &mut R) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader while assuming no arguments have been passed

fn read_args<R>(reader: &mut R, args: Self::Args) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader using the specified arguments

fn after_parse<R>(
    &mut self,
    &mut R,
    &ReadOptions,
    Self::Args
) -> Result<(), Error> where
    R: Read + Seek, 

fn args_default() -> Option<Self::Args>

The default arguments to be used when using the read shortcut method. Override this for any type that optionally requries arguments

impl Debug for ShaderProgram

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShaderProgram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ShaderProgram

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl SsbhWrite for ShaderProgram

fn ssbh_write<W: Write + Seek>(
    &self,
    writer: &mut W,
    data_ptr: &mut u64
) -> Result<()>

Writes the byte representation of self to writer and update data_ptr as needed to ensure the next relative offset is correctly calculated.

fn size_in_bytes(&self) -> u64

The offset in bytes between successive elements in an array of this type. This should include any alignment or padding. For most types, this is simply the value of std::mem::size_of.

fn alignment_in_bytes(&self) -> u64

The alignment of the relative_offset for types stored in a RelPtr64.