vkGetRayTracingShaderGroupStackSizeKHR(3)

# vkGetRayTracingShaderGroupStackSizeKHR(3) Manual Page

## Name

vkGetRayTracingShaderGroupStackSizeKHR - Query ray tracing pipeline shader group shader stack size

Loading… please wait.

## C Specification

To query the pipeline stack size of shaders in a shader group in the ray tracing pipeline, call:

    // Provided by VK_KHR_ray_tracing_pipeline
    VkDeviceSize vkGetRayTracingShaderGroupStackSizeKHR(
        VkDevice                                    device,
        VkPipeline                                  pipeline,
        uint32_t                                    group,
        VkShaderGroupShaderKHR                      groupShader);

## Parameters

- `device` is the logical device containing the ray tracing pipeline.

- `pipeline` is the ray tracing pipeline object containing the shaders groups.

- `group` is the index of the shader group to query.

- `groupShader` is the type of shader from the group to query.

## Description

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

Valid Usage

- VUID-vkGetRayTracingShaderGroupStackSizeKHR-pipeline-04622
  `pipeline` must be a ray tracing pipeline

- VUID-vkGetRayTracingShaderGroupStackSizeKHR-group-03608
  The value of `group` must be less than the number of shader groups in `pipeline`

- VUID-vkGetRayTracingShaderGroupStackSizeKHR-groupShader-03609
  The shader identified by `groupShader` in `group` must not be `VK_SHADER_UNUSED_KHR`

Valid Usage (Implicit)

- VUID-vkGetRayTracingShaderGroupStackSizeKHR-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkGetRayTracingShaderGroupStackSizeKHR-pipeline-parameter
  `pipeline` must be a valid VkPipeline handle

- VUID-vkGetRayTracingShaderGroupStackSizeKHR-groupShader-parameter
  `groupShader` must be a valid VkShaderGroupShaderKHR value

- VUID-vkGetRayTracingShaderGroupStackSizeKHR-pipeline-parent
  `pipeline` must have been created, allocated, or retrieved from `device`

## See Also

VK_KHR_ray_tracing_pipeline, VkDevice, VkPipeline, VkShaderGroupShaderKHR

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0