Struct RayTracingPipeline 

pub struct RayTracingPipeline { /* private fields */ }

Smart pointer handle of a ray tracing pipeline object.

Also contains information about the object.

See VkPipeline.

Implementations

impl RayTracingPipeline

pub fn create<S>( device: &Device, info: impl Into<RayTracingPipelineInfo>, shaders: impl IntoIterator<Item = S>, shader_groups: impl IntoIterator<Item = RayTracingShaderGroup>, ) -> Result<Self, DriverError>

where S: TryInto<Shader>, S::Error: Into<DriverError>,

Creates a new ray tracing pipeline on the given device.

The correct pipeline stages will be enabled based on the provided shaders. See Shader for details on all available stages.

See VkRayTracingPipelineCreateInfoKHR.

The number and composition of the shader_groups parameter must match the actual shaders provided.

shaders may contain pre-built Shader values or any inputs that can be converted into them. Invalid shader data is returned as DriverError::InvalidData through the Result instead of panicking.

Examples

Basic usage:

// shader code is raw SPIR-V code as bytes
let info = RayTracingPipelineInfo::default().into_builder().max_ray_recursion_depth(1);
let pipeline = RayTracingPipeline::create(
    &device,
    info,
    [
        Shader::new_ray_gen(my_rgen_code.as_slice()),
        Shader::new_closest_hit(my_chit_code.as_slice()),
        Shader::new_miss(my_miss_code.as_slice()),
        Shader::new_miss(my_shadow_code.as_slice()),
    ],
    [
        RayTracingShaderGroup::new_general(0),
        RayTracingShaderGroup::new_triangles(1, None),
        RayTracingShaderGroup::new_general(2),
        RayTracingShaderGroup::new_general(3),
    ],
)?;

assert_ne!(pipeline.handle(), vk::Pipeline::null());
assert_eq!(pipeline.info().max_ray_recursion_depth, 1);

pub fn device(&self) -> &Device

The device which owns this ray tracing pipeline.

pub fn group_handle(&self, idx: usize) -> &[u8]

Returns a handle to a shader group of this pipeline.

This can be used to construct a shader binding table.

Examples

See ray_tracing.rs for a detailed example that constructs a shader binding table buffer using this function.

See vkGetRayTracingShaderGroupHandlesKHR.

pub fn group_stack_size( &self, group: u32, group_shader: ShaderGroupShaderKHR, ) -> DeviceSize

Queries ray tracing pipeline shader group shader stack size.

The return value is the ray tracing pipeline stack size in bytes for the specified shader as called from the specified shader group.

See vkGetRayTracingShaderGroupStackSizeKHR.

pub fn handle(&self) -> Pipeline

The native Vulkan pipeline handle of this ray tracing pipeline.

pub fn info(&self) -> RayTracingPipelineInfo

Gets the information used to create this object.

pub fn set_debug_name(&self, name: impl AsRef<str>)

Sets the debugging name assigned to this pipeline.

pub fn with_debug_name(self, name: impl AsRef<str>) -> Self

Sets the debugging name assigned to this pipeline.

Trait Implementations

impl Clone for RayTracingPipeline

fn clone(&self) -> RayTracingPipeline

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RayTracingPipeline

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

Formats the value using the given formatter.

impl Eq for RayTracingPipeline

impl Hash for RayTracingPipeline

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 PartialEq for RayTracingPipeline

fn eq(&self, other: &Self) -> 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<'a> Pipeline<'a> for RayTracingPipeline

type Command = PipelineCommand<'a, RayTracingPipeline>

The resource reference type.

fn bind_cmd(self, cmd: Command<'a>) -> Self::Command

Binds the resource to a command.

impl<'a> Pipeline<'a> for &'a RayTracingPipeline

type Command = PipelineCommand<'a, RayTracingPipeline>

The resource reference type.

fn bind_cmd(self, cmd: Command<'a>) -> Self::Command

Binds the resource to a command.