Structures

VkRayTracingPipelineCreateInfoNV

Structure specifying parameters of a newly created ray tracing pipeline

The VkRayTracingPipelineCreateInfoNV structure is defined as:

typedef struct VkRayTracingPipelineCreateInfoNV {
    VkStructureType sType;
    const void* pNext;
    VkPipelineCreateFlags flags;
    uint32_t stageCount;
    const VkPipelineShaderStageCreateInfo* pStages;
    uint32_t groupCount;
    const VkRayTracingShaderGroupCreateInfoNV* pGroups;
    uint32_t maxRecursionDepth;
    VkPipelineLayout layout;
    VkPipeline basePipelineHandle;
    int32_t basePipelineIndex;
} VkRayTracingPipelineCreateInfoNV;

pub struct RayTracingPipelineCreateInfoNV {
    s_type: vk::StructureType,
    p_next: *const c_void,
    flags: vk::PipelineCreateFlags, // Pipeline creation flags
    stage_count: u32,
    p_stages: *const vk::PipelineShaderStageCreateInfo, // One entry for each active shader stage
    group_count: u32,
    p_groups: *const vk::RayTracingShaderGroupCreateInfoNV,
    max_recursion_depth: u32,
    layout: vk::PipelineLayout, // Interface layout of the pipeline
    base_pipeline_handle: vk::Pipeline, // If VK_PIPELINE_CREATE_DERIVATIVE_BIT is set and this value is nonzero, it specifies the handle of the base pipeline this is a derivative of
    base_pipeline_index: i32, // If VK_PIPELINE_CREATE_DERIVATIVE_BIT is set and this value is not -1, it specifies an index into pCreateInfos of the base pipeline this is a derivative of
}

sType is a VkStructureType value identifying this structure.
pNext is NULL or a pointer to a structure extending this structure.
flags is a bitmask of VkPipelineCreateFlagBits specifying how the pipeline will be generated.
stageCount is the number of entries in the pStages array.
pStages is a pointer to an array of VkPipelineShaderStageCreateInfo structures specifying the set of the shader stages to be included in the ray tracing pipeline.
groupCount is the number of entries in the pGroups array.
pGroups is a pointer to an array of VkRayTracingShaderGroupCreateInfoNV structures describing the set of the shader stages to be included in each shader group in the ray tracing pipeline.
maxRecursionDepth is the maximum recursion depth of shaders executed by this pipeline.
layout is the description of binding locations used by both the pipeline and descriptor sets used with the pipeline. If VkPhysicalDeviceProperties::apiVersion is greater than or equal to Vulkan 1.3 or VK_KHR_maintenance4 is enabled layout must not be accessed by the implementation outside of the duration of the command this structure is passed to.
basePipelineHandle is a pipeline to derive from.
basePipelineIndex is an index into the pCreateInfos parameter to use as a pipeline to derive from.

The parameters basePipelineHandle and basePipelineIndex are described in more detail in Pipeline Derivatives.

If the pNext chain includes a VkPipelineCreateFlags2CreateInfo structure, VkPipelineCreateFlags2CreateInfo::flags from that structure is used instead of flags from this structure.

Valid Usage

VUID-VkRayTracingPipelineCreateInfoNV-None-09497

If the pNext chain does not include a VkPipelineCreateFlags2CreateInfo structure, flags must be a valid combination of VkPipelineCreateFlagBits values

VUID-VkRayTracingPipelineCreateInfoNV-flags-07984

If flags contains the VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineIndex is -1, basePipelineHandle must be a valid ray tracing VkPipeline handle

VUID-VkRayTracingPipelineCreateInfoNV-flags-07985

If flags contains the VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, and basePipelineHandle is VK_NULL_HANDLE, basePipelineIndex must be a valid index into the calling command’s pCreateInfos parameter

VUID-VkRayTracingPipelineCreateInfoNV-flags-07986

If flags contains the VK_PIPELINE_CREATE_DERIVATIVE_BIT flag, basePipelineIndex must be -1 or basePipelineHandlemust be VK_NULL_HANDLE

VUID-VkRayTracingPipelineCreateInfoNV-layout-07987

If a push constant block is declared in a shader and layout is not VK_NULL_HANDLE, a push constant range in layout must match the shader stage

VUID-VkRayTracingPipelineCreateInfoNV-layout-10069

If a push constant block is declared in a shader and layout is not VK_NULL_HANDLE, the block must be contained inside the push constant range in layout that matches the stage

VUID-VkRayTracingPipelineCreateInfoNV-layout-07988

If a resource variable is declared in a shader and layout is not VK_NULL_HANDLE, the corresponding descriptor set in layout must match the shader stage

VUID-VkRayTracingPipelineCreateInfoNV-layout-07990

If a resource variable is declared in a shader, layout is not VK_NULL_HANDLE, and the descriptor type is not VK_DESCRIPTOR_TYPE_MUTABLE_EXT, the corresponding descriptor set in layout must match the descriptor type

VUID-VkRayTracingPipelineCreateInfoNV-layout-07991

If a resource variable is declared in a shader as an array and layout is not VK_NULL_HANDLE, the corresponding descriptor binding used to create layout must have a descriptorCount that is greater than or equal to the length of the array

VUID-VkRayTracingPipelineCreateInfoNV-None-10391

If a resource variables is declared in a shader as an array of descriptors, then the descriptor type of that variable must not be VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK

VUID-VkRayTracingPipelineCreateInfoNV-flags-11798

If shader64BitIndexing feature is not enabled, flags must not contain VK_PIPELINE_CREATE_2_64_BIT_INDEXING_BIT_EXT

VUID-VkRayTracingPipelineCreateInfoNV-pipelineCreationCacheControl-02878

If the pipelineCreationCacheControl feature is not enabled, flagsmust not include VK_PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT nor VK_PIPELINE_CREATE_EARLY_RETURN_ON_FAILURE_BIT

VUID-VkRayTracingPipelineCreateInfoNV-pipelineProtectedAccess-07368

If the pipelineProtectedAccess feature is not enabled, flagsmust not include VK_PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT nor VK_PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT

VUID-VkRayTracingPipelineCreateInfoNV-flags-07369

flags must not include both VK_PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT and VK_PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT

VUID-VkRayTracingPipelineCreateInfoNV-flags-11311

If VkPipelineCreateFlags2CreateInfoKHR::flags includes VK_PIPELINE_CREATE_2_DESCRIPTOR_HEAP_BIT_EXT, layout must be VK_NULL_HANDLE

VUID-VkRayTracingPipelineCreateInfoNV-flags-11312

If VkPipelineCreateFlags2CreateInfoKHR::flags includes VK_PIPELINE_CREATE_2_DESCRIPTOR_HEAP_BIT_EXT, all shader variables in the shader resource interface with a DescriptorSet and Binding decoration must have a mapping declared in VkShaderDescriptorSetAndBindingMappingInfoEXT::pMappings

VUID-VkRayTracingPipelineCreateInfoNV-pStages-03426

The shader code for the entry points identified by pStages, and the rest of the state identified by this structure must adhere to the pipeline linking rules described in the Shader Interfaces chapter

VUID-VkRayTracingPipelineCreateInfoNV-layout-03428

The number of resources in layout accessible to each shader stage that is used by the pipeline must be less than or equal to VkPhysicalDeviceLimits::maxPerStageResources

VUID-VkRayTracingPipelineCreateInfoNV-flags-02904

flags must not include VK_PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV

VUID-VkRayTracingPipelineCreateInfoNV-flags-12341

flags must not include VK_PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT nor VK_PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT

VUID-VkRayTracingPipelineCreateInfoNV-stage-06232

The stage member of at least one element of pStages must be VK_SHADER_STAGE_RAYGEN_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-03456

flags must not include VK_PIPELINE_CREATE_LIBRARY_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-maxRecursionDepth-03457

maxRecursionDepth must be less than or equal to VkPhysicalDeviceRayTracingPropertiesNV::maxRecursionDepth

VUID-VkRayTracingPipelineCreateInfoNV-flags-03458

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_ANY_HIT_SHADERS_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-03459

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_CLOSEST_HIT_SHADERS_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-03460

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_MISS_SHADERS_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-03461

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_NO_NULL_INTERSECTION_SHADERS_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-03462

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_SKIP_AABBS_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-03463

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_SKIP_TRIANGLES_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-03588

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_SHADER_GROUP_HANDLE_CAPTURE_REPLAY_BIT_KHR

VUID-VkRayTracingPipelineCreateInfoNV-flags-04948

flags must not include VK_PIPELINE_CREATE_RAY_TRACING_ALLOW_MOTION_BIT_NV

VUID-VkRayTracingPipelineCreateInfoNV-flags-02957

flags must not include both VK_PIPELINE_CREATE_DEFER_COMPILE_BIT_NV and VK_PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT at the same time

VUID-VkRayTracingPipelineCreateInfoNV-pipelineStageCreationFeedbackCount-06651

If VkPipelineCreationFeedbackCreateInfo::pipelineStageCreationFeedbackCount is not 0, it must be equal to stageCount

VUID-VkRayTracingPipelineCreateInfoNV-stage-06898

The stage value in all pStages elements must be one of VK_SHADER_STAGE_RAYGEN_BIT_KHR, VK_SHADER_STAGE_ANY_HIT_BIT_KHR, VK_SHADER_STAGE_CLOSEST_HIT_BIT_KHR, VK_SHADER_STAGE_MISS_BIT_KHR, VK_SHADER_STAGE_INTERSECTION_BIT_KHR, or VK_SHADER_STAGE_CALLABLE_BIT_KHR

VK_NV_ray_tracing

Type

Structures

Extended By

VkPipelineCreateFlags2CreateInfo VkPipelineCreationFeedbackCreateInfo VkPipelineOfflineCreateInfo

VkRayTracingPipelineCreateInfoNV

Valid Usage

Valid Usage (Implicit)