module
CorridorsContains shared definitions between the vaults.
Namespace: Corridors
Modules
- module CommonStrings
- module Flags_and_Bitmasks
- module Pointers
- module Common_Object_Types
- Common Object Types Specification
Namespaces
- namespace VV::Corridors
Classes
- struct VV::Corridors::InstanceExt
- struct VV::Corridors::DeviceExt
- struct VV::Corridors::Layer
- struct VV::Corridors::ClearValue
- struct VV::Corridors::ComponentMapping
- Structure specifying a color component mapping.
- struct VV::Corridors::ExtensionProperties
- Structure specifying an extension properties.
- struct VV::Corridors::FormatProperties
- struct VV::Corridors::LayerProperties
- struct VV::Corridors::StencilOperationState
- struct VV::Corridors::Viewport
- Surface viewing region.
- struct VV::Corridors::Display
Enums
- enum class EUndefined: ui32 { VV_SpecifyBitmaskable = sizeof(ui32) }
- enum class EAPI_Version { _1_0 = VK_API_VERSION_1_0, _1_1 = VK_API_VERSION_1_1, _1_2 = VK_API_VERSION_1_2 }
- enum class ESamplerAddressMode: ui32 { Repeat = VK_SAMPLER_ADDRESS_MODE_REPEAT, MirroredRepeat = VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT, ClampToEdge = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, ClampToBorder = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER, MirrorClampToEdge = VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE, MirrorClampToEdge_KHR = VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE_KHR }
- Specification
- enum class ESamplerCreateFlag: ui32 { Subsampled_EXT = VK_SAMPLER_CREATE_SUBSAMPLED_BIT_EXT, SubsampledCoarseReconstruction_EXT = VK_SAMPLER_CREATE_SUBSAMPLED_COARSE_RECONSTRUCTION_BIT_EXT, VV_SpecifyBitmaskable = VK_SAMPLER_CREATE_FLAG_BITS_MAX_ENUM }
- Specification
- enum class ESemaphoreImportFlag { Temporary = VK_SEMAPHORE_IMPORT_TEMPORARY_BIT, Temporary_KHR = VK_SEMAPHORE_IMPORT_TEMPORARY_BIT_KHR, VV_SpecifyBitmaskable = VK_SEMAPHORE_IMPORT_FLAG_BITS_MAX_ENUM }
- Specification
- enum class EValidationCheck: ui32 { All = VK_VALIDATION_CHECK_ALL_EXT, Shaders = VK_VALIDATION_CHECK_SHADERS_EXT }
- Specification
Typedefs
- using ui32 = unsigned int
- using si32 = signed int
- using s8 = signed char
- using s16 = signed short int
- using s32 = signed long int
- using s64 = signed long long int
- using u8 = unsigned char
- using u16 = unsigned short int
- using u32 = unsigned long int
- using u64 = unsigned long long int
- using f32 = float
- using f64 = double
- using VoidPtr = void*
- using RoVoidPtr = const void*
- using PtrArray = void*[]
- using CStr = char*
- using RoCStr = const char*
- using CStrArray = char**
- using RoCStrArray = const char**
- Readonly c-string array.
- using RoArray_of_RoCStr = const char*const *
- Array of readonly array of readonly c-string.
-
template<class Type>using Deque = std::deque<Type>
- Containers used for the library are defined here.
-
template<class Type>using DynamicArray = std::vector<Type>
- Typedef of std::vector.
- using UUID = unsigned int[UUID_Size]
- Universally unique identifier.
Functions
- auto MakeVersion(u32 _major, u32 _minor, u32 _patch) -> u32
- Construct an API version number.
Variables
- DeviceSize MaxMemoryHeaps constexpr
- Maximum number of heap elements in a physical device's memory properties.
- DeviceSize MaxMemoryTypes constexpr
- Maximum number of memory type elements in a physical device's memory properties.
- DeviceSize QueueFamily_Ignored constexpr
- Used in resource synchronization and render pass commands.
- ui32 Subpass_External constexpr
- Used in render pass subpass related functionality.
- static RoCStr LunarG_API_Dump constexpr
- Prints API calls, parameters, and values to the identified output stream. It has several settings that can be adjusted by either environment variables or by using the vk_layer_settings.txt file.
- static RoCStr LunarG_Monitor constexpr
- Prints the real-time frames-per-second value to the application's title bar. (Only works on the most recently opened window)
- static RoCStr LunarG_Screenshot constexpr
- Records frames to image files.
- static RoCStr LunarG_CoreValidation constexpr
- The VK_LAYER_LUNARG_core_validation layer validates the status of descriptor sets, command buffers, shader modules, pipeline states, renderpass usage, synchronization, dynamic states and is the workhorse layer for many other types of valid usage.
- static RoCStr LunarG_ParameterValidation constexpr
- Checks the input parameters to API calls for validity.
- static RoCStr LunarG_ObjectTracker constexpr
- Tracks all Vulkan objects. Object lifetimes are validated along with issues related to unknown objects and object destruction and cleanup.
- static RoCStr Google_Threading constexpr
- Checks multi-threading of API calls for validity. Checks performed by this layer include ensuring that only one thread at a time uses an object in free-threaded API calls.
- static RoCStr Google_UniqueObjedcts constexpr
- Wrap all Vulkan objects in a unique pointer at create time and unwrap them at use time.
- static RoCStr LunarG_StandardValidation constexpr
- This is a meta-layer managed by the loader. On desktop systems, specifying this layer name will cause the loader to load the all of the standard validation layers.
- static RoCStr Khronos_Validation constexpr
- Encompasses the complete functionality that had previously been provided.
- DeviceSize UUID_Size constexpr
Enum documentation
enum class EUndefined: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class EAPI_Version
#include <VaultedVulkan/VV_Enums.hpp>
enum class ESamplerAddressMode: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class ESamplerCreateFlag: ui32
#include <VaultedVulkan/VV_Enums.hpp>
enum class ESemaphoreImportFlag
#include <VaultedVulkan/VV_Enums.hpp>
enum class EValidationCheck: ui32
#include <VaultedVulkan/VV_Enums.hpp>
Typedef documentation
using ui32 = unsigned int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using si32 = signed int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using s8 = signed char
#include <VaultedVulkan/VV_CPP_STL.hpp>
using s16 = signed short int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using s32 = signed long int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using s64 = signed long long int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using u8 = unsigned char
#include <VaultedVulkan/VV_CPP_STL.hpp>
using u16 = unsigned short int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using u32 = unsigned long int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using u64 = unsigned long long int
#include <VaultedVulkan/VV_CPP_STL.hpp>
using f32 = float
#include <VaultedVulkan/VV_CPP_STL.hpp>
using f64 = double
#include <VaultedVulkan/VV_CPP_STL.hpp>
using VoidPtr = void*
#include <VaultedVulkan/VV_CPP_STL.hpp>
using RoVoidPtr = const void*
#include <VaultedVulkan/VV_CPP_STL.hpp>
using PtrArray = void*[]
#include <VaultedVulkan/VV_CPP_STL.hpp>
using CStr = char*
#include <VaultedVulkan/VV_CPP_STL.hpp>
using RoCStr = const char*
#include <VaultedVulkan/VV_CPP_STL.hpp>
using CStrArray = char**
#include <VaultedVulkan/VV_CPP_STL.hpp>
using RoCStrArray = const char**
#include <VaultedVulkan/VV_CPP_STL.hpp>
Readonly c-string array.
using RoArray_of_RoCStr = const char*const *
#include <VaultedVulkan/VV_CPP_STL.hpp>
Array of readonly array of readonly c-string.
#include <VaultedVulkan/VV_CPP_STL.hpp>
template<class Type>
using Deque = std::deque<Type>
Containers used for the library are defined here.
If library user decides to implement their own containers they must define containers that function the same as the STL containers used here with the same names.
Typdef of std::deque.
#include <VaultedVulkan/VV_CPP_STL.hpp>
template<class Type>
using DynamicArray = std::vector<Type>
Typedef of std::vector.
using UUID = unsigned int[UUID_Size]
#include <VaultedVulkan/VV_Types.hpp>
Universally unique identifier.
Function documentation
u32 MakeVersion(u32 _major, u32 _minor, u32 _patch)
Construct an API version number.
Parameters | |
---|---|
_major | Major version number. |
_minor | Minor version number. |
_patch | Patch version number. |
Variable documentation
DeviceSize MaxMemoryHeaps constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Maximum number of heap elements in a physical device's memory properties.
DeviceSize MaxMemoryTypes constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Maximum number of memory type elements in a physical device's memory properties.
DeviceSize QueueFamily_Ignored constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Used in resource synchronization and render pass commands.
ui32 Subpass_External constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Used in render pass subpass related functionality.
static RoCStr LunarG_API_Dump constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Prints API calls, parameters, and values to the identified output stream. It has several settings that can be adjusted by either environment variables or by using the vk_layer_settings.txt file.
static RoCStr LunarG_Monitor constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Prints the real-time frames-per-second value to the application's title bar. (Only works on the most recently opened window)
static RoCStr LunarG_Screenshot constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Records frames to image files.
static RoCStr LunarG_CoreValidation constexpr
#include <VaultedVulkan/VV_Constants.hpp>
The VK_LAYER_LUNARG_core_validation layer validates the status of descriptor sets, command buffers, shader modules, pipeline states, renderpass usage, synchronization, dynamic states and is the workhorse layer for many other types of valid usage.
https://vulkan.lunarg.com/doc/view/1.1.85.0/linux/core_
static RoCStr LunarG_ParameterValidation constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Checks the input parameters to API calls for validity.
static RoCStr LunarG_ObjectTracker constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Tracks all Vulkan objects. Object lifetimes are validated along with issues related to unknown objects and object destruction and cleanup.
static RoCStr Google_Threading constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Checks multi-threading of API calls for validity. Checks performed by this layer include ensuring that only one thread at a time uses an object in free-threaded API calls.
static RoCStr Google_UniqueObjedcts constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Wrap all Vulkan objects in a unique pointer at create time and unwrap them at use time.
static RoCStr LunarG_StandardValidation constexpr
#include <VaultedVulkan/VV_Constants.hpp>
This is a meta-layer managed by the loader. On desktop systems, specifying this layer name will cause the loader to load the all of the standard validation layers.
static RoCStr Khronos_Validation constexpr
#include <VaultedVulkan/VV_Constants.hpp>
Encompasses the complete functionality that had previously been provided.
DeviceSize UUID_Size constexpr
#include <VaultedVulkan/VV_Types.hpp>