Class GPUSwapChainVulkan

Window swap chain for Vulkan backend.

GPUSwapChainVulkan

Inherited Members

GPUResourceBase::_device

GPUSwapChain::_downloadTask

GPUSwapChain::_format

ScriptingObject::_gcHandle

GPUSwapChain::_height

ScriptingObject::_id

GPUResource::_memoryUsage

GPUResource::_nameCapacity

GPUResource::_namePtr

GPUResource::_nameSize

GPUSwapChain::_presentCount

ScriptingObject::_type

GPUSwapChain::_width

GPUSwapChain::_window

ResourceOwnerVulkan::ArraySlices

GPUSwapChain::Begin(RenderTask* task)

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

ScriptingObject::Cast(ScriptingObject* obj)

ScriptingObject::ChangeID(const Guid& newId)

ScriptingObject::CreateManaged()

ScriptingObject::CreateManagedInternal()

ScriptingObject::Deleted

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

ScriptingObject::DestroyManaged()

GPUSwapChain::DownloadDataAsync(TextureData& result)

GPUSwapChain::End(RenderTask* task)

Object::Flags

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

GPUSwapChain::GetAspectRatio()

ScriptingObject::GetClass()

GPUResourceBase::GetDevice()

GPUSwapChain::GetFormat()

GPUSwapChain::GetHeight()

ScriptingObject::GetID()

ScriptingObject::GetManagedInstance()

GPUResource::GetMemoryUsage()

GPUResource::GetName()

ScriptingObject::GetOrCreateManagedInstance()

GPUSwapChain::GetPresentCount()

GPUSwapChain::GetResourceType()

GPUSwapChain::GetSize()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

GPUSwapChain::GetWidth()

GPUSwapChain::GetWindow()

GPUResource::GPUResource()

GPUResource::GPUResource(const SpawnParams& params)

GPUResourceBase::GPUResourceBase(DeviceType* device, const StringView& name)

GPUResourceVulkan::GPUResourceVulkan(GPUDeviceVulkan* device, const StringView& name)

GPUSwapChain::GPUSwapChain()

ScriptingObject::HasManagedInstance()

ResourceOwnerVulkan::initResource(VkImageLayout initialState, int32 mipLevels=1, int32 arraySize=1, bool usePerSubresourceTracking=false)

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

GPUSwapChain::IsReady()

ScriptingObject::IsRegistered()

GPUResource::LastRenderTime

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

GPUResource::OnDeleteObject()

GPUResourceBase::OnDeviceDispose()

ScriptingObject::OnManagedInstanceDeleted()

ScriptingObject::OnScriptingDispose()

ScriptingObject::RegisterObject()

GPUResource::ReleaseGPU()

GPUResource::Releasing

ScriptingObject::ScriptingObject(const SpawnParams& params)

ScriptingObject::SetManagedInstance(MObject* instance)

GPUResource::SetName(const StringView& name)

GPUSwapChainVulkan

ResourceOwnerVulkan::State

GPUSwapChainVulkan

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

GPUSwapChain::ToString()

ScriptingObject::UnregisterObject()

GPUResource::~GPUResource()

GPUResourceBase::~GPUResourceBase()

Object::~Object()

ResourceOwnerVulkan::~ResourceOwnerVulkan()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/GraphicsDevice/Vulkan/GPUSwapChainVulkan.h

Syntax

public class GPUSwapChainVulkan : public GPUResourceVulkan, public ResourceOwnerVulkan

Constructors

GPUSwapChainVulkan(GPUDeviceVulkan* device, Window* window)

Declaration

public GPUSwapChainVulkan(GPUDeviceVulkan* device, Window* window)

Parameters

GPUDeviceVulkan device

Window window

Methods

AcquireNextImage(SemaphoreVulkan*& outSemaphore)

Declaration

public int32 AcquireNextImage(SemaphoreVulkan*& outSemaphore)

Parameters

SemaphoreVulkan outSemaphore

Returns

int32

AsGPUResource()

Gets resource owner object as a GPUResource type or returns null if cannot perform cast.

Declaration

public virtual GPUResource* AsGPUResource() const override

Returns

GPUResource

GPU Resource or null if cannot cast.

Overrides

ResourceOwnerVulkan::AsGPUResource()

CopyBackbuffer(GPUContext* context, GPUTexture* dst)

Copies the backbuffer contents to the destination texture.

Declaration

public virtual void CopyBackbuffer(GPUContext* context, GPUTexture* dst) override

Parameters

GPUContext context

The GPU commands context.

GPUTexture dst

The destination texture. It must match the output dimensions and format. No staging texture support.

Overrides

GPUSwapChain::CopyBackbuffer(GPUContext* context, GPUTexture* dst)

DoAcquireImageIndex(GPUSwapChainVulkan* viewport, void* customData)

Declaration

public static int32 DoAcquireImageIndex(GPUSwapChainVulkan* viewport, void* customData)

Parameters

GPUSwapChainVulkan viewport

void customData

Returns

int32

DoPresent(GPUSwapChainVulkan* viewport, void* customData)

Declaration

public static int32 DoPresent(GPUSwapChainVulkan* viewport, void* customData)

Parameters

GPUSwapChainVulkan viewport

void customData

Returns

int32

GetBackBufferView()

Gets the view for the output back buffer texture (for the current frame rendering).

Declaration

public virtual GPUTextureView* GetBackBufferView() override

Returns

GPUTextureView

The output texture view to use.

Overrides

GPUSwapChain::GetBackBufferView()

GetSurface()

Gets the Vulkan surface.

Declaration

public VkSurfaceKHR GetSurface() const

Returns

VkSurfaceKHR

The surface object.

GetSwapChain()

Gets the Vulkan surface swap chain.

Declaration

public VkSwapchainKHR GetSwapChain() const

Returns

VkSwapchainKHR

The swap chain object.

IsFullscreen()

True if running in fullscreen mode.

Declaration

public virtual bool IsFullscreen() override

Returns

bool

True if is in fullscreen mode, otherwise false

Overrides

GPUSwapChain::IsFullscreen()

OnReleaseGPU()

Releases GPU resource data (implementation).

Declaration

protected virtual void OnReleaseGPU() override

Overrides

GPUResource::OnReleaseGPU()

Present(bool vsync)

Present back buffer to the output.

Declaration

public virtual void Present(bool vsync) override

Parameters

bool vsync

True if use vertical synchronization to lock frame rate.

Overrides

GPUSwapChain::Present(bool vsync)

Present(QueueVulkan* presentQueue, SemaphoreVulkan* backBufferRenderingDoneSemaphore)

Declaration

public Status Present(QueueVulkan* presentQueue, SemaphoreVulkan* backBufferRenderingDoneSemaphore)

Parameters

QueueVulkan presentQueue

SemaphoreVulkan backBufferRenderingDoneSemaphore

Returns

Status

Resize(int32 width, int32 height)

Resize output back buffer.

Declaration

public virtual bool Resize(int32 width, int32 height) override

Parameters

int32 width

New output width (in pixels).

int32 height

New output height (in pixels).

Returns

bool

True if cannot resize the buffers, otherwise false.

Overrides

GPUSwapChain::Resize(int32 width, int32 height)

SetFullscreen(bool isFullscreen)

Set the fullscreen state.

Declaration

public virtual void SetFullscreen(bool isFullscreen) override

Parameters

bool isFullscreen

Fullscreen mode to apply

Overrides

GPUSwapChain::SetFullscreen(bool isFullscreen)

TryPresent(Function<int32(GPUSwapChainVulkan* , void* )> job, void* customData=nullptr, bool skipOnOutOfDate=false)

Declaration

public int32 TryPresent(Function<int32(GPUSwapChainVulkan* , void* )> job, void* customData=nullptr, bool skipOnOutOfDate=false)

Parameters

Function<int32(GPUSwapChainVulkan , void )> job

void customData

bool skipOnOutOfDate

Returns

int32