Class RenderToolsVulkan

Set of utilities for rendering on Vulkan platform.

Inheritance

RenderToolsVulkan

Assembly: FlaxEngine.dll

File: Engine/GraphicsDevice/Vulkan/RenderToolsVulkan.h

Syntax

public class RenderToolsVulkan

Methods

GetAccess(GPUResourceAccess access)

Declaration

public static VkAccessFlags GetAccess(GPUResourceAccess access)

Parameters

GPUResourceAccess access

Returns

VkAccessFlags

GetBufferBarrierFlags(VkAccessFlags accessFlags)

Declaration

public static VkPipelineStageFlags GetBufferBarrierFlags(VkAccessFlags accessFlags)

Parameters

VkAccessFlags accessFlags

Returns

VkPipelineStageFlags

GetImageBarrierFlags(VkImageLayout layout, VkAccessFlags& accessFlags)

Declaration

public static VkPipelineStageFlags GetImageBarrierFlags(VkImageLayout layout, VkAccessFlags& accessFlags)

Parameters

VkImageLayout layout

VkAccessFlags accessFlags

Returns

VkPipelineStageFlags

GetImageLayout(GPUResourceAccess access)

Declaration

public static VkImageLayout GetImageLayout(GPUResourceAccess access)

Parameters

GPUResourceAccess access

Returns

VkImageLayout

GetVkErrorString(VkResult result)

Declaration

public static String GetVkErrorString(VkResult result)

Parameters

VkResult result

Returns

String

HasExtension(const Array<const char* , HeapAllocation>& extensions, const char* name)

Declaration

public static bool HasExtension(const Array<const char* , HeapAllocation>& extensions, const char* name)

Parameters

Array<char , HeapAllocation> extensions

char name

Returns

bool

LogVkResult(VkResult result, const char* file=nullptr, uint32 line = 0, bool fatal=false)

Declaration

public static void LogVkResult(VkResult result, const char* file=nullptr, uint32 line = 0, bool fatal=false)

Parameters

VkResult result

char file

uint32 line

bool fatal

SetObjectName(VkDevice device, uint64 objectHandle, VkObjectType objectType, const char* name)

Declaration

public static void SetObjectName(VkDevice device, uint64 objectHandle, VkObjectType objectType, const char* name)

Parameters

VkDevice device

uint64 objectHandle

VkObjectType objectType

char name

SetObjectName(VkDevice device, uint64 objectHandle, VkObjectType objectType, const String& name)

Declaration

public static void SetObjectName(VkDevice device, uint64 objectHandle, VkObjectType objectType, const String& name)

Parameters

VkDevice device

uint64 objectHandle

VkObjectType objectType

String name

ToVulkanBlendOp(const BlendingMode::Operation value)

Converts Flax blend operation to the Vulkan blend operation.

Declaration

public static VkBlendOp ToVulkanBlendOp(const BlendingMode::Operation value)

Parameters

BlendingMode::Operation value The Flax blend operation.

Returns

VkBlendOp The Vulkan blend operation.

ToVulkanCompareOp(const ComparisonFunc value)

Converts Flax comparison function to the Vulkan comparison operation.

Declaration

public static VkCompareOp ToVulkanCompareOp(const ComparisonFunc value)

Parameters

ComparisonFunc value The Flax comparison function.

Returns

VkCompareOp The Vulkan comparison operation.

ToVulkanFormat(const PixelFormat value)

Converts Flax Pixel Format to the Vulkan Format.

Declaration

public static VkFormat ToVulkanFormat(const PixelFormat value)

Parameters

PixelFormat value The Flax Pixel Format.

Returns

VkFormat The Vulkan Format.

ToVulkanMagFilterMode(GPUSamplerFilter filter)

Declaration

public static VkFilter ToVulkanMagFilterMode(GPUSamplerFilter filter)

Parameters

GPUSamplerFilter filter

Returns

VkFilter

ToVulkanMinFilterMode(GPUSamplerFilter filter)

Declaration

public static VkFilter ToVulkanMinFilterMode(GPUSamplerFilter filter)

Parameters

GPUSamplerFilter filter

Returns

VkFilter

ToVulkanMipFilterMode(GPUSamplerFilter filter)

Declaration

public static VkSamplerMipmapMode ToVulkanMipFilterMode(GPUSamplerFilter filter)

Parameters

GPUSamplerFilter filter

Returns

VkSamplerMipmapMode

ToVulkanSamplerCompareFunction(GPUSamplerCompareFunction samplerComparisonFunction)

Declaration

public static VkCompareOp ToVulkanSamplerCompareFunction(GPUSamplerCompareFunction samplerComparisonFunction)

Parameters

GPUSamplerCompareFunction samplerComparisonFunction

Returns

VkCompareOp

ToVulkanWrapMode(GPUSamplerAddressMode addressMode, const bool supportsMirrorClampToEdge)

Declaration

public static VkSamplerAddressMode ToVulkanWrapMode(GPUSamplerAddressMode addressMode, const bool supportsMirrorClampToEdge)

Parameters

GPUSamplerAddressMode addressMode

bool supportsMirrorClampToEdge

Returns

VkSamplerAddressMode

ZeroStruct(T& data, VkStructureType type)

Declaration

public static void ZeroStruct(T& data, VkStructureType type)

Parameters

T data

VkStructureType type

Returns

void

Type Parameters

class T