Stay organized with collections
Save and categorize content based on your preferences.
CardboardVulkanDistortionRendererTarget
#include <cardboard.h>
Struct to set Vulkan distortion renderer target.
Summary
Public attributes
swapchain_image_index
uint32_t CardboardVulkanDistortionRendererTarget::swapchain_image_index
The index of the image in the swapchain.
This number should NOT exceed the number of images in swapchain. If this number is above the swapchain length, the distortion renderer will stop and return directly.
vk_command_buffer
uint64_t CardboardVulkanDistortionRendererTarget::vk_command_buffer
The command buffer object.
This field holds aVkCommandBuffer value. Maintained by the user and this command buffer should be started before calling the rendering function.
vk_render_pass
uint64_t CardboardVulkanDistortionRendererTarget::vk_render_pass
The render pass object that will be used to bind vertex, indices and descriptor set.
This field holds a VkRenderPass value. Maintained by the user.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[null,null,["Last updated 2024-08-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eCardboardVulkanDistortionRendererTarget\u003c/code\u003e is a struct used to define the target for the Vulkan distortion renderer.\u003c/p\u003e\n"],["\u003cp\u003eIt includes \u003ccode\u003eswapchain_image_index\u003c/code\u003e, \u003ccode\u003evk_command_buffer\u003c/code\u003e, and \u003ccode\u003evk_render_pass\u003c/code\u003e attributes to specify the rendering target.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eswapchain_image_index\u003c/code\u003e must be within the valid range of the swapchain's images to ensure proper rendering.\u003c/p\u003e\n"],["\u003cp\u003eUsers are responsible for managing and starting the \u003ccode\u003evk_command_buffer\u003c/code\u003e and setting up the \u003ccode\u003evk_render_pass\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# CardboardVulkanDistortionRendererTarget Struct Reference\n\nCardboardVulkanDistortionRendererTarget\n=======================================\n\n`#include \u003ccardboard.h\u003e`\n\nStruct to set Vulkan distortion renderer target.\n\nSummary\n-------\n\n| ### Public attributes ||\n|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|\n| [swapchain_image_index](#struct_cardboard_vulkan_distortion_renderer_target_1a309e7ead979cddb466dabacd770e7dfd) | `uint32_t` The index of the image in the swapchain. |\n| [vk_command_buffer](#struct_cardboard_vulkan_distortion_renderer_target_1a14e32c24c035e566b2e8b187c5fefc91) | `uint64_t` The command buffer object. |\n| [vk_render_pass](#struct_cardboard_vulkan_distortion_renderer_target_1a5a52719d6c9055315a11769efc26ad7d) | `uint64_t` The render pass object that will be used to bind vertex, indices and descriptor set. |\n\nPublic attributes\n-----------------\n\n### swapchain_image_index\n\n```scdoc\nuint32_t CardboardVulkanDistortionRendererTarget::swapchain_image_index\n``` \nThe index of the image in the swapchain.\n\nThis number should NOT exceed the number of images in swapchain. If this number is above the swapchain length, the distortion renderer will stop and return directly. \n\n### vk_command_buffer\n\n```scdoc\nuint64_t CardboardVulkanDistortionRendererTarget::vk_command_buffer\n``` \nThe command buffer object.\n\nThis field holds a[VkCommandBuffer value](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VkCommandBuffer.html). Maintained by the user and this command buffer should be started before calling the rendering function. \n\n### vk_render_pass\n\n```scdoc\nuint64_t CardboardVulkanDistortionRendererTarget::vk_render_pass\n``` \nThe render pass object that will be used to bind vertex, indices and descriptor set.\n\nThis field holds a [VkRenderPass value](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VkRenderPass.html). Maintained by the user."]]