ash/extensions/khr/
ray_tracing_pipeline.rs

1//! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_ray_tracing_pipeline.html>
2
3use crate::prelude::*;
4use crate::vk;
5use crate::RawPtr;
6use alloc::vec::Vec;
7
8impl crate::khr::ray_tracing_pipeline::Device {
9    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdTraceRaysKHR.html>
10    #[inline]
11    pub unsafe fn cmd_trace_rays(
12        &self,
13        command_buffer: vk::CommandBuffer,
14        raygen_shader_binding_tables: &vk::StridedDeviceAddressRegionKHR,
15        miss_shader_binding_tables: &vk::StridedDeviceAddressRegionKHR,
16        hit_shader_binding_tables: &vk::StridedDeviceAddressRegionKHR,
17        callable_shader_binding_tables: &vk::StridedDeviceAddressRegionKHR,
18        width: u32,
19        height: u32,
20        depth: u32,
21    ) {
22        (self.fp.cmd_trace_rays_khr)(
23            command_buffer,
24            raygen_shader_binding_tables,
25            miss_shader_binding_tables,
26            hit_shader_binding_tables,
27            callable_shader_binding_tables,
28            width,
29            height,
30            depth,
31        );
32    }
33
34    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCreateRayTracingPipelinesKHR.html>
35    ///
36    /// Pipelines are created and returned as described for [Multiple Pipeline Creation].
37    ///
38    /// [Multiple Pipeline Creation]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#pipelines-multiple
39    #[inline]
40    pub unsafe fn create_ray_tracing_pipelines(
41        &self,
42        deferred_operation: vk::DeferredOperationKHR,
43        pipeline_cache: vk::PipelineCache,
44        create_infos: &[vk::RayTracingPipelineCreateInfoKHR<'_>],
45        allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
46    ) -> Result<Vec<vk::Pipeline>, (Vec<vk::Pipeline>, vk::Result)> {
47        let mut pipelines = Vec::with_capacity(create_infos.len());
48        let err_code = (self.fp.create_ray_tracing_pipelines_khr)(
49            self.handle,
50            deferred_operation,
51            pipeline_cache,
52            create_infos.len() as u32,
53            create_infos.as_ptr(),
54            allocation_callbacks.as_raw_ptr(),
55            pipelines.as_mut_ptr(),
56        );
57        pipelines.set_len(create_infos.len());
58        match err_code {
59            vk::Result::SUCCESS => Ok(pipelines),
60            _ => Err((pipelines, err_code)),
61        }
62    }
63
64    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetRayTracingShaderGroupHandlesKHR.html>
65    #[inline]
66    pub unsafe fn get_ray_tracing_shader_group_handles(
67        &self,
68        pipeline: vk::Pipeline,
69        first_group: u32,
70        group_count: u32,
71        data_size: usize,
72    ) -> VkResult<Vec<u8>> {
73        let mut data = Vec::<u8>::with_capacity(data_size);
74        (self.fp.get_ray_tracing_shader_group_handles_khr)(
75            self.handle,
76            pipeline,
77            first_group,
78            group_count,
79            data_size,
80            data.as_mut_ptr().cast(),
81        )
82        .set_vec_len_on_success(data, data_size)
83    }
84
85    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetRayTracingCaptureReplayShaderGroupHandlesKHR.html>
86    #[inline]
87    pub unsafe fn get_ray_tracing_capture_replay_shader_group_handles(
88        &self,
89        pipeline: vk::Pipeline,
90        first_group: u32,
91        group_count: u32,
92        data_size: usize,
93    ) -> VkResult<Vec<u8>> {
94        let mut data = Vec::<u8>::with_capacity(data_size);
95        (self
96            .fp
97            .get_ray_tracing_capture_replay_shader_group_handles_khr)(
98            self.handle,
99            pipeline,
100            first_group,
101            group_count,
102            data_size,
103            data.as_mut_ptr().cast(),
104        )
105        .set_vec_len_on_success(data, data_size)
106    }
107
108    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdTraceRaysIndirectKHR.html>
109    ///
110    /// `indirect_device_address` is a buffer device address which is a pointer to a [`vk::TraceRaysIndirectCommandKHR`] structure containing the trace ray parameters.
111    #[inline]
112    pub unsafe fn cmd_trace_rays_indirect(
113        &self,
114        command_buffer: vk::CommandBuffer,
115        raygen_shader_binding_table: &vk::StridedDeviceAddressRegionKHR,
116        miss_shader_binding_table: &vk::StridedDeviceAddressRegionKHR,
117        hit_shader_binding_table: &vk::StridedDeviceAddressRegionKHR,
118        callable_shader_binding_table: &vk::StridedDeviceAddressRegionKHR,
119        indirect_device_address: vk::DeviceAddress,
120    ) {
121        (self.fp.cmd_trace_rays_indirect_khr)(
122            command_buffer,
123            raygen_shader_binding_table,
124            miss_shader_binding_table,
125            hit_shader_binding_table,
126            callable_shader_binding_table,
127            indirect_device_address,
128        );
129    }
130
131    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetRayTracingShaderGroupStackSizeKHR.html>
132    #[inline]
133    pub unsafe fn get_ray_tracing_shader_group_stack_size(
134        &self,
135        pipeline: vk::Pipeline,
136        group: u32,
137        group_shader: vk::ShaderGroupShaderKHR,
138    ) -> vk::DeviceSize {
139        (self.fp.get_ray_tracing_shader_group_stack_size_khr)(
140            self.handle,
141            pipeline,
142            group,
143            group_shader,
144        )
145    }
146
147    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdSetRayTracingPipelineStackSizeKHR.html>
148    #[inline]
149    pub unsafe fn cmd_set_ray_tracing_pipeline_stack_size(
150        &self,
151        command_buffer: vk::CommandBuffer,
152        pipeline_stack_size: u32,
153    ) {
154        (self.fp.cmd_set_ray_tracing_pipeline_stack_size_khr)(command_buffer, pipeline_stack_size);
155    }
156}
ash/extensions/khr/ray_tracing_pipeline.rs

ash/extensions/khr/
ray_tracing_pipeline.rs
