Struct screen_13::driver::shader::ShaderBuilder

pub struct ShaderBuilder { /* private fields */ }

Builder for Shader.

Implementations

impl ShaderBuilder

pub fn entry_name(self, value: String) -> Self

The name of the entrypoint which will be executed by this shader.

The default value is main.

pub fn specialization_info(self, value: SpecializationInfo) -> Self

Data about Vulkan specialization constants.

Examples

Basic usage (GLSL):

#version 460 core

// Defaults to 6 if not set using ComputePipelineInfo.specialization_info!
layout(constant_id = 0) const uint MY_COUNT = 6;

layout(set = 0, binding = 0) uniform sampler2D my_samplers[MY_COUNT];

void main()
{
    // Code uses MY_COUNT number of my_samplers here
}

// We instead specify 42 for MY_COUNT:
let shader = Shader::new_fragment(my_shader_code.as_slice())
    .specialization_info(SpecializationInfo::new(
        [vk::SpecializationMapEntry {
            constant_id: 0,
            offset: 0,
            size: 4,
        }],
        42u32.to_ne_bytes()
    ));

pub fn spirv(self, value: Vec<u8>) -> Self

Shader code.

Although SPIR-V code is specified as u32 values, this field uses u8 in order to make loading from file simpler. You should always have a SPIR-V code length which is a multiple of four bytes, or a panic will happen during pipeline creation.

pub fn stage(self, value: ShaderStageFlags) -> Self

The shader stage this structure applies to.

pub fn entry_point(self, value: EntryPoint) -> Self

impl ShaderBuilder

pub fn new(stage: ShaderStageFlags, spirv: Vec<u8>) -> Self

Specifies a shader with the given stage and shader code values.

pub fn build(self) -> Shader

Builds a new Shader.

Trait Implementations

impl Default for ShaderBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<ShaderBuilder> for Shader

fn from(shader: ShaderBuilder) -> Self

Converts to this type from the input type.