VaultedThermals » Vault_0 module

Backend vault for VaultedThermals.

Contents

For now only abstracts away OS Platform details and basic meta-structure definitions.

Namespaces

namespace VV::V0

Classes

struct VV::V0::DummyBase
Used when creating fake VulkanAPI structures for platform abstraction uses.
template<typename VulkanType, EStructureType TemplateSpecifiedStype = EStructureType::Max_Enum>
struct VV::V0::VKStruct_Base
Base struct for wrapping Vulkan native C API Structs.
template<typename Enum, typename = void>
struct VV::V0::IsBitmaskable
Used when the enum does not meet the criteria for bitmaskable.
template<typename Enum>
struct VV::V0::IsBitmaskable<Enum, decltype(static_cast<void>(Enum::VV_SpecifyBitmaskable))>
Will be defined with a true_type when enum has the VV_SpecifyBitmaskable enum value.
template<typename EnumType, typename BitmaskRepresentation>
class VV::V0::Bitfield
struct VV::V0::Memory
General memory definitions.
template<EOS>
struct VV::V0::PlatformTypes_Maker
Defines maker of platform struct that defines operating system types.
template<>
struct VV::V0::PlatformTypes_Maker<EOS::Linux>
template<>
struct VV::V0::PlatformTypes_Maker<EOS::Windows>
Defines Windows specific types.
struct VV::V0::Surface_PlatformAgnostic
Cross-Platform set of definitions for a Surface.
template<EOS>
struct VV::V0::Surface_Maker
Used to create an OS platform's surface type.
template<>
struct VV::V0::Surface_Maker<EOS::Windows>
Defines a Surface's extended definitions for Windows.

Enums

enum class EOS { Windows, Mac, Linux }
Enum specifies operating system platform.

Typedefs

using ShouldUse_EResult = typename std::conditional<V0::UseSTL_Exceptions, void, EResult>::type
Determines whether to return an result code for a function based on if STL exceptions are enabled.
using PlatformTypes = PlatformTypes_Maker<OS_Platform>
A structure containing the types for the detected platform.

Functions

template<typename Enum>
auto Bitmaskable() -> std::enable_if<IsBitmaskable<Enum>::value, bool>::type constexpr noexcept
Returns true if IsBitmaskable is false.

Variables

bool UseSTL_Exceptions constexpr
STL Exceptions (Note: right now the library does not STL exceptions but may in the future...):

Defines

#define VV_InlineSpecifier
Note: I do not use these as no optimization via inlining has been looked into as of yet...

Enum documentation

enum class EOS
#include <VaultedVulkan/VV_Platform.hpp>

Enum specifies operating system platform.

Typedef documentation

using ShouldUse_EResult = typename std::conditional<V0::UseSTL_Exceptions, void, EResult>::type
#include <VaultedVulkan/VV_Backend.hpp>

Determines whether to return an result code for a function based on if STL exceptions are enabled.

using PlatformTypes = PlatformTypes_Maker<OS_Platform>
#include <VaultedVulkan/VV_Platform.hpp>

A structure containing the types for the detected platform.

Function documentation

#include <VaultedVulkan/VV_Backend.hpp>
template<typename Enum>
std::enable_if<IsBitmaskable<Enum>::value, bool>::type Bitmaskable() constexpr noexcept

Returns true if IsBitmaskable is false.

Variable documentation

bool UseSTL_Exceptions constexpr
#include <VaultedVulkan/VV_Backend.hpp>

STL Exceptions (Note: right now the library does not STL exceptions but may in the future...):

Define documentation

#define VV_InlineSpecifier
#include <VaultedVulkan/VV_Backend.hpp>

Note: I do not use these as no optimization via inlining has been looked into as of yet...

Inline specification set to none. (Does not do influence compiler)