 | |
Vulkan | |
The VulkanDevice type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddCopyImageCommands(CommandBuffer, GpuImage, GpuImage, Boolean, ImageLayout, Int32) | |
| AddCopyImageCommands(CommandBuffer, Image, ImageLayout, AccessFlags, PipelineStageFlags, Image, ImageCopy, ImageLayout, AccessFlags, PipelineStageFlags, Boolean, ImageLayout, AccessFlags, PipelineStageFlags) | |
| AddCopyImageCommands(CommandBuffer, Image, ImageLayout, AccessFlags, PipelineStageFlags, Image, Int32, Int32, AccessFlags, ImageLayout, PipelineStageFlags, Boolean, ImageLayout, Int32) | |
| AddFullPipelineBarrier | |
| AllocateMemory(Buffer, MemoryPropertyFlags, Boolean, String) | |
| AllocateMemory(Image, MemoryPropertyFlags, Boolean, String) | |
| AllocateMemory(MemoryRequirements, MemoryPropertyFlags, Boolean, Boolean, String) | |
| AllocateMemory(UInt32, UInt32, Int32, MemoryPropertyFlags, Boolean, Boolean, String) | |
| AllocateShaderSpecializationInfoT(T, Int32, String) | |
| AllocateShaderSpecializationInfoT(T, Int32, String) | |
| BeginCommandsBuffer | |
| BeginGraphicsCommands | |
| CacheObject | CacheObject sets the specified objectToCache to the specified key in the dictionary used by this VulkanDevice. The cached object can be retrieved by GetCachedObjectT(String) or removed by RemoveCachedObject(String) method. This method is thread safe and can be called from any thread. |
| CalculateMipLevelsCount | |
 | CheckDeviceMinimumRequirements(VulkanInstance, PhysicalDevice, Boolean) | Returns true if the specified physicalDevice is supported to run Ab4d.SharpEngine. |
| CheckDeviceMinimumRequirements(PhysicalDeviceDetails, SurfaceDetails, Boolean, Boolean) | Returns true if the physicalDevice (specified in physicalDeviceDetails) is supported to run SharpEngine. When isSurfaceSupportRequired is true, then also the vulkanSurface is checked. |
| CheckDeviceMinimumRequirements(VulkanInstance, PhysicalDevice, SurfaceKHR, Boolean, Boolean) | Returns true if the specified physicalDevice is supported to run Ab4d.SharpEngine. When isSurfaceSupportRequired is true, then also the vulkanSurface is checked. |
| CheckIsOnMainThread | CheckIsOnMainThread method thrown an exception when the current thread is not main thread. |
| CopyBuffer | CopyBuffer copies the sourceBuffer to the destinationBuffer and waits for the copy operation to finish. When size is not defined (is zero), then size of the smaller buffer is used. |
| CopyDataToGpuImage(GpuImage, GpuBuffer, Boolean, ImageLayout, AccessFlags, PipelineStageFlags) | |
| CopyDataToGpuImage(GpuImage, Int32, Int32, Int32, DeviceMemory, Int32, Byte, ImageLayout, AccessFlags, PipelineStageFlags) | |
| CopyDataToGpuImage(Image, Int32, Int32, Int32, AccessFlags, ImageLayout, PipelineStageFlags, DeviceMemory, Int32, Byte, ImageLayout, AccessFlags, PipelineStageFlags, Int32) | |
| CopyDataToImage(Image, Int32, Int32, Int32, AccessFlags, ImageLayout, PipelineStageFlags, GpuBuffer, ImageLayout, AccessFlags, PipelineStageFlags, Int32) | |
| CopyDataToImage(CommandBuffer, Image, Int32, Int32, Int32, AccessFlags, ImageLayout, PipelineStageFlags, GpuBuffer, ImageLayout, AccessFlags, PipelineStageFlags, UInt32, UInt32, Int32) | |
| CopyDataToImage3D | |
| CopyGpuImage | |
| CopyImage(Image, ImageLayout, AccessFlags, PipelineStageFlags, Image, ImageCopy, ImageLayout, AccessFlags, PipelineStageFlags, Boolean, ImageLayout, AccessFlags, PipelineStageFlags, NullableSemaphore, NullableSemaphore) | |
| CopyImage(Image, ImageLayout, AccessFlags, PipelineStageFlags, Image, Int32, Int32, AccessFlags, ImageLayout, PipelineStageFlags, Boolean, ImageLayout, Int32, NullableSemaphore, NullableSemaphore) | |
| CopyToGpuImage | |
| Create(ActionEngineCreateOptions, String) | Creates an instance of VulkanDevice by using an action that defines the EngineCreateOptions. This method will also create a VulkanInstance if it was not created before. |
| Create(EngineCreateOptions, String) | Creates an instance of VulkanDevice. Optionally the EngineCreateOptions can be used to specify the creation options. This method will also create a VulkanInstance if it was not created before. |
| Create(SurfaceKHR, EngineCreateOptions, String) | Creates an instance of VulkanDevice that will use the Vulkan surface that is defined by the SurfaceKHR. Optionally the EngineCreateOptions can be used to specify the creation options. This method will also create a VulkanInstance if it was not created before. |
| Create(SurfaceKHR, ActionEngineCreateOptions, String) | Creates an instance of VulkanDevice that will use the Vulkan surface that is defined by the SurfaceKHR and will configure the EngineCreateOptions by using the specified configure action. This method will also create a VulkanInstance if it was not created before. |
| Create(VulkanSurfaceProvider, EngineCreateOptions, String) | Creates an instance of VulkanDevice that will use the Vulkan surface that is defined by the VulkanSurfaceProvider. Optionally the EngineCreateOptions can be used to specify the creation options. This method will also create a VulkanInstance if it was not created before. |
| Create(VulkanSurfaceProvider, ActionEngineCreateOptions, String) | Creates an instance of VulkanDevice that will use the Vulkan surface that is defined by the VulkanSurfaceProvider and will configure the EngineCreateOptions by using the specified configure action. This method will also create a VulkanInstance if it was not created before. |
| Create(VulkanInstance, PhysicalDeviceDetails, EngineCreateOptions, SurfaceKHR, String) | Creates a new VulkanDevice with specified VulkanInstance, PhysicalDeviceDetails, EngineCreateOptions and optional surface and name. |
| Create(VulkanInstance, PhysicalDevice, EngineCreateOptions, SurfaceKHR, String) | Creates a new VulkanDevice with specified VulkanInstance, PhysicalDevice, EngineCreateOptions and optional surface and name. |
| CreateBufferT(ReadOnlySpan, Void, T, BufferCreateInfo) | |
| CreateBufferT(Span, Void, T, BufferCreateInfo) | |
| CreateBufferT(ReadOnlySpan, Void, T, BufferUsageFlags, Boolean) | |
| CreateBufferT(Span, Void, T, BufferUsageFlags, Boolean) | |
| CreateBufferT(T, BufferUsageFlags, QueueFlags, MemoryPropertyFlags, String) | |
| CreateBufferT(T, BufferUsageFlags, Boolean, Boolean, String) | |
| CreateBufferT(Int32, BufferUsageFlags, Boolean, Boolean, Boolean, String) | |
| CreateBufferT(ReadOnlySpan, Void, T, BufferUsageFlags, Boolean, Boolean) | |
| CreateBufferT(Span, Void, T, BufferUsageFlags, Boolean, Boolean) | |
| CreateBufferT(T, BufferUsageFlags, Boolean, Boolean, Boolean, String) | |
| CreateBufferT(T, Int32, BufferUsageFlags, QueueFlags, MemoryPropertyFlags, String) | |
| CreateBufferT(T, Int32, BufferUsageFlags, Boolean, Boolean, String) | |
| CreateBufferT(T, Int32, BufferUsageFlags, Boolean, Boolean, Boolean, String) | |
| CreateBufferAsyncT(T, BufferUsageFlags, Boolean, Boolean, String) | CreateBufferAsync method creates the GpuBuffer and uploads the specified data in the background thread. |
| CreateBufferAsyncT(T, Int32, BufferUsageFlags, Boolean, Boolean, String) | CreateBufferAsync method creates the GpuBuffer and uploads the specified data in the background thread. |
| CreateBuffers(Int32, Int32, BufferUsageFlags, Type, Int32, String) | |
| CreateBuffers(Int32, Int32, BufferUsageFlags, Type, Int32, Boolean, String) | |
| CreateCommandBuffer | |
| CreateCommandBuffers | |
| CreateCommandPool | |
| CreateDescriptorPool(DescriptorType, Int32, Boolean, String) | |
| CreateDescriptorPool(DescriptorType, Int32, Boolean, String) | |
| CreateDescriptorPool(DescriptorType, Int32, Boolean, String) | |
| CreateDescriptorSetLayout(DescriptorType, ShaderStageFlags, String) | |
| CreateDescriptorSetLayout(DescriptorType, ShaderStageFlags, Int32, String) | |
| CreateDescriptorSetLayout(DescriptorType, ShaderStageFlags, Int32, String) | |
| CreateDescriptorSets | |
| CreateDynamicUniformBuffers | |
| CreateFence | |
| CreateFrameBuffers(ImageView, ImageView, Int32, Int32, RenderPass, String) | |
| CreateFrameBuffers(ImageView, ImageView, Int32, Int32, RenderPass, Framebuffer, String) | |
| CreateGraphicsCommandPool | |
| CreateImageViews(Image, Format, ImageAspectFlags, String) | |
| CreateImageViews(Image, Format, ImageView, ImageAspectFlags, String) | |
| CreateMultiSampledFrameBuffers | |
| CreateMultiSampledRenderPass | |
| CreatePipelineLayout(DescriptorSetLayout, PushConstantRange, String) | |
| CreatePipelineLayout(DescriptorSetLayout, Int32, Int32, String) | |
| CreatePostProcessRenderPass | |
| CreateSampler | |
| CreateSemaphore | |
| CreateStagingBuffer(Int32, Boolean, QueueFlags, String) | Creates a GpuBuffer that can be used for transferring data to the GPU (isTransferSource: true) or from the GPU (isTransferSource: false). To use staging buffer with batch update, use the StagingGpuBuffer from this device or create a new GpuStagingBuffer. |
| CreateStagingBufferT(Int32, Boolean, QueueFlags, String) | Creates a GpuBuffer that can be used for transferring data to the GPU (isTransferSource: true) or from the GPU (isTransferSource: false). To use staging buffer with batch update, use the StagingGpuBuffer from this device or create a new GpuStagingBuffer. |
| CreateStandardRenderPass | |
| CreateSwapChain | |
| CreateSwapChainImages(SwapchainKHR, String) | |
| CreateSwapChainImages(SwapchainKHR, Image, String) | |
| CreateUniformBuffers | |
| DisableBackgroundUpload | DisableBackgroundUpload disables background upload of images and buffer even if it is supported by the graphics card. |
| Dispose | Dispose |
 | Dispose(Boolean) |
Dispose
(Overrides ComponentBaseDispose(Boolean)) |
| DisposeVulkanResourceOnMainThreadAfterFrameRendered | DisposeVulkanResourceOnMainThreadAfterFrameRendered method disposes the Vulkan resources with the specified type and handle on the main thread and after the rendering of the current frame is complete and the GPU resources for that frame are no longer used. If this is called on the main thread and if the current frame is already fully rendered (for example after calling WaitUntilIdle, then the specified Vulkan resource is immediately disposed. This method can be called from any thread. |
| DumpMemoryReport | Writes string that contains details memory usage of this device. |
| DumpResources | Writes string that contains details tracked resources (objected derived from ComponentBase) to the console (when the application is debugged in Visual Studio the result is written to Output window or Immediate Window if started from there; in Rider the result is written to Debug Output window). To get a meaningful result, enable tracking resource on application startup. This can be done by setting static ComponentBase.ResourcesTracker.IsTrackingResources to true. |
| DumpResourcesForDelayedDisposal | Writes string that contains details about resources that are scheduled to be disposed when the background rendering of frames is completed. |
| EnableBackgroundUpload | EnableBackgroundUpload can be called after calling DisableBackgroundUpload to re-enable the background upload of images and buffer. Note that if the graphics card does not support background upload, then calling this method will not actually enable background upload (it will just prevent disabling it). |
| EndCommandBuffer(CommandBuffer, Queue, Boolean, Boolean) | |
| EndCommandBuffer(CommandBuffer, Queue, Boolean, Boolean, Semaphore, Semaphore) | |
| EndCommandBuffer(CommandBuffer, Queue, Boolean, Boolean, Semaphore, Semaphore, Fence) | |
| EndGraphicsCommands(Boolean, Boolean) | |
| EndGraphicsCommands(Semaphore, Semaphore) | |
| ExecuteOnMainThread | ExecuteOnMainThread executes the specified action on the main thread (the same thread the VulkanDevice was created on). If this is called on the main thread, then the action is immediately executed, otherwise the action is saved and it will be executed when the RunAllUpdateActions method will be called (usually at the beginning of the update render phase). This method can be called from any thread. |
| ExecuteOnMainThreadAfterFrameRendered | ExecuteOnMainThreadAfterFrameRendered executes the specified action on the main thread (the same thread the VulkanDevice was created on) and after the rendering of the current frame is complete and the GPU resources for that frame are no longer used. If this is called on the main thread and if the current frame is already fully rendered (for example after calling WaitUntilIdle, then the action is immediately executed, otherwise the action is saved and it will be executed when on the main thread and after the frame is rendered. This method can be called from any thread. |
| FlushStagingCommandBuffers | FlushStagingCommandBuffers start writing all the data that were added to StagingGpuBuffer. When waitUntilFinished is true, then the method waits until all the copy operations are finished. If waitUntilFinished is false, then user can call WaitForStagingCommandBuffers at some later stage. |
| FreeMemory | |
| FreeMemoryBlockOnMainThreadAfterFrameRendered(VulkanMemoryInfo) | |
| FreeMemoryBlockOnMainThreadAfterFrameRendered(IDynamicMemoryBlock, Int32) | |
| GetCachedObjectT | GetCachedObject gets the object that was previously stored by the to CacheObject(String, Object) method. If the key is not found a default value of T (null for reference types) is returned. This method is thread safe and can be called from any thread. |
| GetCachedObjectsReportString | Returns a string that shows which objects are cached by this VulkanDevice. |
| GetDeviceLocalMemoryBudget | Returns the MemoryHeapBudget that defines the memory budged and current usage for GPU's device local memory. If the memory budget is not available (IsMemoryBudgetInfoAvailable is false), then the returned object will have all values set to 0. |
| GetHostVisibleMemoryBudget | Returns the MemoryHeapBudget that defines the memory budged and current usage for main CPU's memory that can be used for graphics objects. If the memory budget is not available (IsMemoryBudgetInfoAvailable is false), then the returned object will have all values set to 0. |
| GetMemoryBudget | Gets the memory budgets and usage for each memory heap in this GPU device. To see if this method is supported, check IsMemoryBudgetInfoAvailable property (supported on Vulkan API 1.1 and when the device supports the VK_EXT_memory_budget extension). If this is not supported, then an empty list is returned. |
| GetMemoryBudgetInfo | Returns a string that shows the memory heaps usage and available budgets. To check if memory budget information is available call the IsMemoryBudgetInfoAvailable method. |
| GetMemoryReportString | Gets a string that contains details memory usage of this device. |
| GetOrCreateDescriptorSetsCache | GetOrCreateDescriptorSetsCache returns an existing DescriptorSetsCache that has the same descriptorTypes, stageFlags and startBinding. If no DescriptorSetsCache exist with that properties, then a new DescriptorSetsCache is created an returned. The new DescriptorSetsCache is returned in subsequent calls to GetOrCreateDescriptorSetsCache with the same properties. DescriptorSetsCache can be used to cache the DescriptorSets so that the same storage buffer and texture image with sampler use the same DescriptorSet. The created DescriptorSetsCache will be disposed when this VulkanDevice is disposed. |
| GetPipelineCache | |
| GetPreTransform | |
| GetResourcesForDelayedDisposalString | |
| GetResourcesReportString | Gets a string with report of tracked resources (objected derived from ComponentBase). To get a meaningful result, enable tracking resource on application startup. This can be done by setting static ComponentBase.ResourcesTracker.IsTrackingResources to true. |
| GetSupportedDepthStencilFormat | |
| GetVulkanFormat | |
| InsertImageMemoryBarrier(CommandBuffer, GpuImage, ImageLayout) | |
| InsertImageMemoryBarrier(CommandBuffer, GpuImage, AccessFlags, ImageLayout, PipelineStageFlags, Int32, Int32, UInt32, UInt32) | |
| InsertImageMemoryBarrier(CommandBuffer, Image, AccessFlags, AccessFlags, ImageLayout, ImageLayout, PipelineStageFlags, PipelineStageFlags, UInt32, UInt32) | |
| InsertImageMemoryBarrier(CommandBuffer, Image, AccessFlags, AccessFlags, ImageLayout, ImageLayout, PipelineStageFlags, PipelineStageFlags, ImageSubresourceRange, UInt32, UInt32) | |
| InsertImageMemoryBarrier(CommandBuffer, Image, AccessFlags, AccessFlags, ImageLayout, ImageLayout, PipelineStageFlags, PipelineStageFlags, Int32, Int32, UInt32, UInt32) | |
| IsOnMainThread | Returns true if the current thread is the same as the thread that was used to create this VulkanDevice. |
| MapMemoryT | |
| ReleaseShaderSpecializationInfo | |
| RemoveCachedObject | RemoveCachedObject removes the specified key from the dictionary used by this VulkanDevice. This method is thread safe and can be called from any thread. |
| RunAllUpdateActions | RunAllUpdateActions executes all the actions that were added by the ExecuteOnMainThread(Action) method. |
| SetupRequestedDeviceFeatures | |
| SetViewport | |
| TransitionImageToShaderReadOnlyOptimalLayout | |
| UnmapMemory | |
| UpdateDescriptorSets | |
| WaitForFence | WaitForFence method first checks the status of the fence. If the status is not signaled, then WaitForFence is called. |
| WaitForStagingCommandBuffers | WaitForStagingCommandBuffers method can be called after calling FlushStagingCommandBuffers(Boolean) with waitUntilFinished parameter set to false. |
| WaitUntilIdle |
See Also