module
APISpec_Render_PassChapter 7: Specification
Classes
- struct VV::V1::Framebuffer::CreateInfo
- Specification
- struct VV::V1::Framebuffer
- Render passes operate in conjunction with framebuffers. Framebuffers represent a collection of specific memory attachments that a render pass instance uses.
- struct VV::V1::RenderPass::AttachmentDescription
- Specification
- struct VV::V1::RenderPass::AttachmentReference
- Specification
- struct VV::V1::RenderPass::BeginInfo
- Specification
- struct VV::V1::RenderPass::SubpassDescription
- Specification
- struct VV::V1::RenderPass::SubpassDependency
- Specification
- struct VV::V1::RenderPass::CreateInfo
- Specification
- struct VV::V1::RenderPass
- A render pass represents a collection of attachments, subpasses, and dependencies between the subpasses, and describes how the attachments are used over the course of the subpasses.
Enums
- enum class EAttachmentDescriptionFlag: ui32 { AttachmentDescription_MAY_ALIAS = VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT, VV_SpecifyBitmaskable = VK_ATTACHMENT_DESCRIPTION_FLAG_BITS_MAX_ENUM }
- Specification
- enum class EAttachmentLoadOperation: ui32 { Load = VK_ATTACHMENT_LOAD_OP_LOAD, Clear = VK_ATTACHMENT_LOAD_OP_CLEAR, DontCare = VK_ATTACHMENT_LOAD_OP_DONT_CARE }
- Specification
- enum class EAttachmentStoreOperation: ui32 { Store = VK_ATTACHMENT_STORE_OP_STORE, DontCare = VK_ATTACHMENT_STORE_OP_DONT_CARE }
- Specification
- enum class EFrameBufferCreateFlag: ui32 { VV_SpecifyBitmaskable = sizeof(ui32) }
- Specification
- enum class EResolveModeFlags: ui32 { None = VK_RESOLVE_MODE_NONE, SampleZero = VK_RESOLVE_MODE_SAMPLE_ZERO_BIT, Average = VK_RESOLVE_MODE_AVERAGE_BIT, Min = VK_RESOLVE_MODE_MIN_BIT, Max = VK_RESOLVE_MODE_MAX_BIT, None_KHR = VK_RESOLVE_MODE_NONE_KHR, SampleZero_KHR = VK_RESOLVE_MODE_SAMPLE_ZERO_BIT_KHR, Average_KHR = VK_RESOLVE_MODE_AVERAGE_BIT_KHR, Min_KHR = VK_RESOLVE_MODE_MIN_BIT_KHR, Max_KHR = VK_RESOLVE_MODE_MAX_BIT_KHR, VV_SpecifyBitmaskable = VK_RESOLVE_MODE_FLAG_BITS_MAX_ENUM }
- Specification
- enum class ESubpassContents: ui32 { Inline = VK_SUBPASS_CONTENTS_INLINE, SecondaryCommandBuffers = VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS }
- Specification
- enum class ESubpassDescriptionFlag: ui32 { VV_SpecifyBitmaskable = sizeof(ui32) }
- Specification
Typedefs
- using Handle = VkFramebuffer
- Specification
- using CreateFlags = Bitfield<EFrameBufferCreateFlag, VkFramebufferCreateFlags>
- Specification
- using Handle = VkRenderPass
- Specification
- using AttachmentDescriptionFlags = Bitfield<EAttachmentDescriptionFlag, VkAttachmentDescriptionFlags>
- Specification
- using SubpassDesriptionFlags = Bitfield<ESubpassDescriptionFlag, VkSubpassDescriptionFlags>
- Specification
- using CreateFlags = Bitfield<EUndefined, VkRenderPassCreateFlags>
- Specification
- using ResolveModeFlags = Bitfield<EResolveModeFlags, VkResolveModeFlags>
Functions
- static void BeginRenderPass(const Handle _commandBuffer, const RenderPass::BeginInfo& _beginInfo, ESubpassContents _contents)
- Specification
- static void EndRenderPass(Handle _commandBuffer)
- Specification .
- static auto Create(LogicalDevice::Handle _deviceHanle, const CreateInfo& _creationSpec, const Memory::AllocationCallbacks* _allocator, Handle& _framebuffer) -> EResult
- Creates a framebuffer.
- static void Destroy(LogicalDevice::Handle _deviceHandle, Handle _framebuffer, const Memory::AllocationCallbacks* _allocator)
- Destroy a framebuffer.
- static auto Create(LogicalDevice::Handle _deviceHandle, const CreateInfo& _createInfo, const Memory::AllocationCallbacks* _allocator, Handle& _renderPass) -> EResult
- Create a render pass.
- static void Destroy(LogicalDevice::Handle _deviceHandle, Handle _renderPass, const Memory::AllocationCallbacks* _allocator)
- Destroy a render pass.
Enum documentation
enum class EAttachmentDescriptionFlag: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class EAttachmentLoadOperation: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class EAttachmentStoreOperation: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class EFrameBufferCreateFlag: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class EResolveModeFlags: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class ESubpassContents: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class ESubpassDescriptionFlag: ui32
#include <VaultedVulkan/VV_Enums.hpp>
Typedef documentation
using Handle = VkFramebuffer
#include <VaultedVulkan/VV_RenderPass.hpp>
using CreateFlags = Bitfield<EFrameBufferCreateFlag, VkFramebufferCreateFlags>
#include <VaultedVulkan/VV_RenderPass.hpp>
using Handle = VkRenderPass
#include <VaultedVulkan/VV_RenderPass.hpp>
using AttachmentDescriptionFlags = Bitfield<EAttachmentDescriptionFlag, VkAttachmentDescriptionFlags>
#include <VaultedVulkan/VV_RenderPass.hpp>
using SubpassDesriptionFlags = Bitfield<ESubpassDescriptionFlag, VkSubpassDescriptionFlags>
#include <VaultedVulkan/VV_RenderPass.hpp>
using CreateFlags = Bitfield<EUndefined, VkRenderPassCreateFlags>
#include <VaultedVulkan/VV_RenderPass.hpp>
using ResolveModeFlags = Bitfield<EResolveModeFlags, VkResolveModeFlags>
#include <VaultedVulkan/VV_Types.hpp>
@ < ="://..////1.2-//.#"></>
Function documentation
static void BeginRenderPass(const Handle _commandBuffer,
const RenderPass::BeginInfo& _beginInfo,
ESubpassContents _contents)
#include <VaultedVulkan/VV_Command.hpp>
static void EndRenderPass(Handle _commandBuffer)
#include <VaultedVulkan/VV_Command.hpp>
Parameters | |
---|---|
_commandBuffer |
static EResult Create(LogicalDevice::Handle _deviceHanle,
const CreateInfo& _creationSpec,
const Memory::AllocationCallbacks* _allocator,
Handle& _framebuffer)
#include <VaultedVulkan/VV_RenderPass.hpp>
Creates a framebuffer.
Parameters | |
---|---|
_deviceHanle | |
_creationSpec | |
_allocator | |
_framebuffer |
static void Destroy(LogicalDevice::Handle _deviceHandle,
Handle _framebuffer,
const Memory::AllocationCallbacks* _allocator)
#include <VaultedVulkan/VV_RenderPass.hpp>
Destroy a framebuffer.
Parameters | |
---|---|
_deviceHandle | |
_framebuffer | |
_allocator |
static EResult Create(LogicalDevice::Handle _deviceHandle,
const CreateInfo& _createInfo,
const Memory::AllocationCallbacks* _allocator,
Handle& _renderPass)
#include <VaultedVulkan/VV_RenderPass.hpp>
Create a render pass.
Parameters | |
---|---|
_deviceHandle | |
_createInfo | |
_allocator | |
_renderPass |
static void Destroy(LogicalDevice::Handle _deviceHandle,
Handle _renderPass,
const Memory::AllocationCallbacks* _allocator)
#include <VaultedVulkan/VV_RenderPass.hpp>
Destroy a render pass.
Parameters | |
---|---|
_deviceHandle | |
_renderPass | |
_allocator |