nCine::RHI::Vulkan namespace

Namespaces

namespace UniformTypeInfo

Free-function helpers that classify reflected uniform types (component count, float-ness).

Classes

class VulkanAttribute

Reflected metadata of a single active vertex attribute (aliased as RHI::Attribute).

class VulkanBufferObject

Buffer object of the Vulkan backend (aliased as RHI::Buffer).

class VulkanDebug

Debug-output and object-labelling stub of the Vulkan backend.

class VulkanDevice

Pipeline-state and draw-call facade of the Vulkan backend (aliased as RHI::Device).

class VulkanFramebuffer

Framebuffer stub of the Vulkan backend (aliased as RHI::Framebuffer).

class VulkanRenderbuffer

Renderbuffer stub of the Vulkan backend (aliased as RHI::Renderbuffer).

class VulkanRenderTarget

Off-screen render target of the Vulkan backend (aliased as RHI::RenderTarget).

class VulkanShader

Shader-object stub of the Vulkan backend.

class VulkanShaderProgram

Shader program of the Vulkan backend (aliased as RHI::ShaderProgram).

class VulkanShaderUniformBlocks

Manages the uniform-block caches of a program (aliased as RHI::ShaderUniformBlocks).

class VulkanShaderUniforms

Manages the loose-uniform caches of a program (aliased as RHI::ShaderUniforms).

class VulkanTexture

Texture object of the Vulkan backend (aliased as RHI::Texture).

class VulkanUniform

Reflected metadata of a single active uniform (aliased as RHI::Uniform).

class VulkanUniformBlock

Reflected metadata of a single active uniform block (aliased as RHI::UniformBlock).

class VulkanUniformBlockCache

Caches the contents of a uniform block (aliased as RHI::UniformBlockCache).

class VulkanUniformCache

Caches the host-side value of a single uniform (aliased as RHI::UniformCache).

class VulkanVertexArray

Vertex array object stub of the Vulkan backend (aliased as RHI::VertexArray).

class VulkanVertexFormat

Vertex layout description of the Vulkan backend (aliased as RHI::VertexFormat).

Enums

enum class VkDeferredResource : std::uint32_t { Image, ImageView, Sampler, Buffer, DeviceMemory, Framebuffer }

Kind of Vulkan handle handed to VkEnqueueDestroy() (selects the right vkDestroy* / vkFreeMemory).

Functions

auto VkDeviceHandle() -> VkDevice

The logical device, or VK_NULL_HANDLE before creation / after teardown.

auto VkPhysicalDeviceHandle() -> VkPhysicalDevice

The selected physical device.

auto VkFindMemoryType(std::uint32_t typeBits, VkMemoryPropertyFlags properties) -> std::uint32_t

Returns a memory type index satisfying typeBits with all properties, or UINT32_MAX if none.

auto VkMinUniformBufferOffsetAlignment() -> VkDeviceSize

The device's minimum uniform-buffer bind-offset alignment (for the per-frame uniform ring).

auto VkBeginOneTimeCommands() -> VkCommandBuffer

Allocates + begins a one-time-submit primary command buffer from the shared graphics pool.

void VkEndOneTimeCommands(VkCommandBuffer commandBuffer)

Ends, submits and waits on a command buffer from VkBeginOneTimeCommands(), then frees it.

void VkRegisterFrameStaging(std::uint64_t buffer, std::uint64_t memory)

Hands a texture-upload staging buffer/memory to the current in-flight frame for deferred destruction.

void VkEnqueueDestroy(VkDeferredResource type, std::uint64_t handle)

Enqueues a GPU resource handle for destruction once no in-flight frame can still reference it.

auto VkGetColorRenderPass(VkFormat format) -> VkRenderPass

Returns (creating/caching on first use) a single-color-attachment render pass for format (loadOp LOAD, storeOp STORE, layout COLOR_ATTACHMENT_OPTIMAL).

auto VkGetColorRenderPassMrt(const VkFormat* formats, std::uint32_t count) -> VkRenderPass

Returns (creating/caching on first use) a color-only render pass over count attachments with the given formats.

Enum documentation

Function documentation