RV_VKEnum.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        RV_VKEnum.h ( RV Library, C++)
 *
 * COMMENTS:
 *      Helper functions for use with Vulkan Enum values
 */

#ifndef RV_VKEnum_h
#define RV_VKEnum_h

#include "RV_API.h"

#include <RE/RE_Types.h>
#include <RE/RE_TextureTypes.h>

#include <VE/VE_VK.h>
#include "RV_Type.h"

// ~~~~~~
// VkFormat Helpers
RV_API bool RVisDepthFormat(VkFormat format);
RV_API bool RVisStencilFormat(VkFormat format);
RV_API bool RVisColorFormat(VkFormat format);
RV_API exint RVgetVkFormatSize(VkFormat);
RV_API VkImageViewType RVgetImageViewType(VkImageType type,
                                          bool is_array,
                                          bool is_cube);

// convert _SIGNED and _UNSIGNED integer type to _NORM integer type 
RV_API VkFormat RVgetNormalizedFormat(VkFormat format);
RV_API bool     RVhasNormalizedFormat(VkFormat format);
RV_API bool     RVisNormalizedFormat(VkFormat format);
RV_API bool     RVisIntFormat(VkFormat format);

RV_API VkFormat RVconvertToVkFormat(RV_GPUType type, uint32_t vec_size,
                                    bool normalized = false);
RV_API VkFormat RVconvertToDepthVkFormat(RV_GPUType type, bool stencil);

// `secondary_aspect` applies to multi-aspect formats, i.e. depth/stencil
RV_API void     RVconvertFromVkFormat(VkFormat format,
                               RV_GPUType &out_type,
                               int &out_vec_size,
                               bool primary_aspect = true);
RV_API VkFormat rvGetVkFormatFromGLFormat(int32 gl_internal_enum);

// ~~~~~~
// VkDescriporType Helpers
RV_API bool RVisBufferDescriptor(VkDescriptorType t);
RV_API bool RVisImageDescriptor(VkDescriptorType t);
RV_API bool RVisTexBufDescriptor(VkDescriptorType t);
RV_API bool RVisAccelStructDescriptor(VkDescriptorType t);

// ~~~~~~
// VkSampleCount Helpers
RV_API VkSampleCountFlagBits RVsampleCount(int samples);

// ~~~~~~
// VkImageViewType 
RV_API RV_ImageDim          RVConvertFromImageViewType(VkImageViewType t);

// ~~~~~~
// VK Image Type helpers
RV_API VkSamplerAddressMode RVConvertToVKWrap(RV_TextureWrap t);
RV_API VkFilter             RVConvertToVkFilter(RV_TextureFilter t);
RV_API VkSamplerMipmapMode  RVConvertToVkMipMode(RV_TextureMipMode t);
RV_API VkBorderColor        RVConvertToVkBorder(UT_Vector4F t);
RV_API VkBorderColor        RVConvertToVkBorder(RE_TextureBorder t);

// ~~~~~~
// VkAccessFlags Helpers
RV_API VkAccessFlags RVaccessFromImageUsage(VkImageUsageFlags usage);
RV_API VkAccessFlags RVaccessFromBufferUsage(VkBufferUsageFlags usage);
RV_API bool RVsAccessReadOnly(VkAccessFlags access);

// ~~~~~~
// VkPipelineBindPoint Helpers
RV_API VkPipelineBindPoint RVconvertToVkBindPoint(RV_ShaderType type);

// ~~~~~~
// VkShaderStageFlags Helpers
RV_API RV_ShaderType RVgetShaderType(VkShaderStageFlagBits stage);
RV_API VkPipelineStageFlags RVpipelineStageFromAccess(
        VkAccessFlags access_type,
        VkPipelineStageFlags shader_stages);

RV_API VkShaderStageFlagBits RVconvertToPipelineStage(RE_ShaderType stage);


// ~~~~~~
// VkPipelineState helpers
RV_API VkCompareOp RVconvertToVkCompareOp(RE_ZFunction func, bool reverse_z);
RV_API VkCompareOp RVconvertToVkCompareOp(RE_SFunction func);
RV_API VkStencilOp RVconvertToVKStencilOp(RE_SOperation op);
RV_API VkBlendFactor RVconvertToVkBlendFactor(RE_BlendSourceFactor fact);
RV_API VkBlendFactor RVconvertToVkBlendFactor(RE_BlendDestFactor fact);
RV_API VkBlendOp RVconvertToVkBlendOp(RE_BlendEquation op);

RV_API RE_ZFunction RVconvertFromVkCompareOp(VkCompareOp func, bool reverse_z);
#endif