KDGpuExample::ExampleEngineLayer¶

#include <KDGpuExample/example_engine_layer.h>

Inherits from KDGpuExample::EngineLayer, KDFoundation::Object

Inherited by KDGpuExample::AdvancedExampleEngineLayer, KDGpuExample::SimpleExampleEngineLayer

Public Functions¶

	Name
	ExampleEngineLayer()
	~ExampleEngineLayer() override
KDGpuKDGui::View *	window()

Protected Functions¶

	Name
virtual void	initializeScene() =0
virtual void	cleanupScene() =0
virtual void	updateScene() =0
virtual void	render() =0
virtual void	resize() =0
virtual void	drawImGuiOverlay(ImGuiContext * ctx)
virtual void	renderImGuiOverlay(RenderPassCommandRecorder * recorder, uint32_t inFlightIndex =0)
void	registerImGuiOverlayDrawFunction(const std::function< void(ImGuiContext *)> & func)
void	clearImGuiOverlayDrawFunctions()
void	recreateImGuiOverlay()
virtual void	onAttached() override
virtual void	onDetached() override
virtual void	update() override
void	event(KDFoundation::EventReceiver * target, KDFoundation::Event * ev) override
virtual void	recreateSwapChain()
void	recreateDepthTexture()
void	recreateSampleDependentResources()
void	uploadBufferData(const BufferUploadOptions & options)
void	uploadTextureData(const TextureUploadOptions & options)
void	releaseStagingBuffers()

Protected Attributes¶

	Name
std::shared_ptr< spdlog::logger >	m_logger
std::unique_ptr< GraphicsApi >	m_api
std::unique_ptr< KDGpuKDGui::View >	m_window
Extent2D	m_swapchainExtent
KDBindings::Property< SampleCountFlagBits >	m_samples
TextureUsageFlags	m_swapchainUsageFlags
std::vector< SampleCountFlagBits >	m_supportedSampleCounts
Instance	m_instance
Surface	m_surface
Device	m_device
Queue	m_queue
PresentMode	m_presentMode
Swapchain	m_swapchain
std::vector< TextureView >	m_swapchainViews
Texture	m_depthTexture
TextureView	m_depthTextureView
std::unique_ptr< ImGuiItem >	m_imguiOverlay
std::vector< std::function< void(ImGuiContext *)> >	m_imGuiOverlayDrawFunctions
uint32_t	m_currentSwapchainImageIndex
uint32_t	m_inFlightIndex
std::array< GpuSemaphore, MAX_FRAMES_IN_FLIGHT >	m_presentCompleteSemaphores
std::array< GpuSemaphore, MAX_FRAMES_IN_FLIGHT >	m_renderCompleteSemaphores
TextureUsageFlags	m_depthTextureUsageFlags
std::vector< UploadStagingBuffer >	m_stagingBuffers
Format	m_swapchainFormat
Format	m_depthFormat
CompositeAlphaFlagBits	m_compositeAlpha
bool	m_showSurfaceCapabilities
std::string	m_capabilitiesString

Additional inherited members¶

Public Functions inherited from KDGpuExample::EngineLayer

	Name
	~EngineLayer() override
const Engine *	engine() const
Engine *	engine()

Friends inherited from KDGpuExample::EngineLayer

	Name
class	Engine

Public Functions Documentation¶

function ExampleEngineLayer¶

ExampleEngineLayer()

function ~ExampleEngineLayer¶

~ExampleEngineLayer() override

function window¶

inline KDGpuKDGui::View * window()

Protected Functions Documentation¶

function initializeScene¶

virtual void initializeScene() =0

Reimplemented by: BindGroupIndexing::initializeScene, BindGroupPartiallyBound::initializeScene, ComputeOitTransparency::initializeScene, ComputeParticles::initializeScene, DepthBias::initializeScene, DepthTextureLookup::initializeScene, DynamicUBOTriangles::initializeScene, HelloSphereRt::initializeScene, HelloTriangle::initializeScene, HelloTriangle::initializeScene, HelloTriangle::initializeScene, HelloTriangle::initializeScene, HelloTriangleMSAA::initializeScene, HelloTriangleRt::initializeScene, MultiView::initializeScene, MultiViewStereo::initializeScene, RenderToTexture::initializeScene, TexturedQuad::initializeScene

function cleanupScene¶

virtual void cleanupScene() =0

Reimplemented by: BindGroupIndexing::cleanupScene, BindGroupPartiallyBound::cleanupScene, ComputeOitTransparency::cleanupScene, ComputeParticles::cleanupScene, DepthBias::cleanupScene, DepthTextureLookup::cleanupScene, DynamicUBOTriangles::cleanupScene, HelloSphereRt::cleanupScene, HelloTriangle::cleanupScene, HelloTriangle::cleanupScene, HelloTriangle::cleanupScene, HelloTriangle::cleanupScene, HelloTriangleMSAA::cleanupScene, HelloTriangleRt::cleanupScene, MultiView::cleanupScene, MultiViewStereo::cleanupScene, RenderToTexture::cleanupScene, TexturedQuad::cleanupScene

function updateScene¶

virtual void updateScene() =0

Reimplemented by: BindGroupIndexing::updateScene, BindGroupPartiallyBound::updateScene, ComputeOitTransparency::updateScene, ComputeParticles::updateScene, DepthBias::updateScene, DepthTextureLookup::updateScene, DynamicUBOTriangles::updateScene, HelloSphereRt::updateScene, HelloTriangle::updateScene, HelloTriangle::updateScene, HelloTriangle::updateScene, HelloTriangle::updateScene, HelloTriangleMSAA::updateScene, HelloTriangleRt::updateScene, MultiView::updateScene, MultiViewStereo::updateScene, RenderToTexture::updateScene, TexturedQuad::updateScene

function render¶

virtual void render() =0

Reimplemented by: BindGroupIndexing::render, BindGroupPartiallyBound::render, ComputeOitTransparency::render, ComputeParticles::render, DepthBias::render, DepthTextureLookup::render, DynamicUBOTriangles::render, HelloSphereRt::render, HelloTriangle::render, HelloTriangle::render, HelloTriangle::render, HelloTriangle::render, HelloTriangleMSAA::render, HelloTriangleRt::render, MultiView::render, MultiViewStereo::render, RenderToTexture::render, TexturedQuad::render

function resize¶

virtual void resize() =0

Reimplemented by: BindGroupIndexing::resize, BindGroupPartiallyBound::resize, ComputeOitTransparency::resize, ComputeParticles::resize, DepthBias::resize, DepthTextureLookup::resize, DynamicUBOTriangles::resize, HelloSphereRt::resize, HelloTriangle::resize, HelloTriangle::resize, HelloTriangle::resize, HelloTriangle::resize, HelloTriangleMSAA::resize, HelloTriangleRt::resize, MultiView::resize, MultiViewStereo::resize, RenderToTexture::resize, TexturedQuad::resize

function drawImGuiOverlay¶

virtual void drawImGuiOverlay(
    ImGuiContext * ctx
)

function renderImGuiOverlay¶

virtual void renderImGuiOverlay(
    RenderPassCommandRecorder * recorder,
    uint32_t inFlightIndex =0
)

function registerImGuiOverlayDrawFunction¶

void registerImGuiOverlayDrawFunction(
    const std::function< void(ImGuiContext *)> & func
)

function clearImGuiOverlayDrawFunctions¶

void clearImGuiOverlayDrawFunctions()

function recreateImGuiOverlay¶

void recreateImGuiOverlay()

function onAttached¶

virtual void onAttached() override

Reimplements: KDGpuExample::EngineLayer::onAttached

function onDetached¶

virtual void onDetached() override

Reimplements: KDGpuExample::EngineLayer::onDetached

function update¶

virtual void update() override

Reimplements: KDGpuExample::EngineLayer::update

Reimplemented by: KDGpuExample::SimpleExampleEngineLayer::update

function event¶

void event(
    KDFoundation::EventReceiver * target,
    KDFoundation::Event * ev
) override

function recreateSwapChain¶

virtual void recreateSwapChain()

Reimplemented by: MultiViewStereo::recreateSwapChain

function recreateDepthTexture¶

void recreateDepthTexture()

function recreateSampleDependentResources¶

void recreateSampleDependentResources()

function uploadBufferData¶

void uploadBufferData(
    const BufferUploadOptions & options
)

function uploadTextureData¶

void uploadTextureData(
    const TextureUploadOptions & options
)

function releaseStagingBuffers¶

void releaseStagingBuffers()

Protected Attributes Documentation¶

variable m_logger¶

std::shared_ptr< spdlog::logger > m_logger;

variable m_api¶

std::unique_ptr< GraphicsApi > m_api;

variable m_window¶

std::unique_ptr< KDGpuKDGui::View > m_window;

variable m_swapchainExtent¶

Extent2D m_swapchainExtent;

variable m_samples¶

KDBindings::Property< SampleCountFlagBits > m_samples { SampleCountFlagBits::Samples1Bit };

variable m_swapchainUsageFlags¶

TextureUsageFlags m_swapchainUsageFlags { TextureUsageFlagBits::ColorAttachmentBit };

variable m_supportedSampleCounts¶

std::vector< SampleCountFlagBits > m_supportedSampleCounts;

variable m_instance¶

Instance m_instance;

variable m_surface¶

Surface m_surface;

variable m_device¶

Device m_device;

variable m_queue¶

Queue m_queue;

variable m_presentMode¶

PresentMode m_presentMode;

variable m_swapchain¶

Swapchain m_swapchain;

variable m_swapchainViews¶

std::vector< TextureView > m_swapchainViews;

variable m_depthTexture¶

Texture m_depthTexture;

variable m_depthTextureView¶

TextureView m_depthTextureView;

variable m_imguiOverlay¶

std::unique_ptr< ImGuiItem > m_imguiOverlay;

variable m_imGuiOverlayDrawFunctions¶

std::vector< std::function< void(ImGuiContext *)> > m_imGuiOverlayDrawFunctions;

variable m_currentSwapchainImageIndex¶

uint32_t m_currentSwapchainImageIndex { 0 };

variable m_inFlightIndex¶

uint32_t m_inFlightIndex { 0 };

variable m_presentCompleteSemaphores¶

std::array< GpuSemaphore, MAX_FRAMES_IN_FLIGHT > m_presentCompleteSemaphores;

variable m_renderCompleteSemaphores¶

std::array< GpuSemaphore, MAX_FRAMES_IN_FLIGHT > m_renderCompleteSemaphores;

variable m_depthTextureUsageFlags¶

TextureUsageFlags m_depthTextureUsageFlags {};

variable m_stagingBuffers¶

std::vector< UploadStagingBuffer > m_stagingBuffers;

variable m_swapchainFormat¶

Format m_swapchainFormat { Format::B8G8R8A8_UNORM };

variable m_depthFormat¶

Format m_depthFormat;

variable m_compositeAlpha¶

CompositeAlphaFlagBits m_compositeAlpha { CompositeAlphaFlagBits::OpaqueBit };

variable m_showSurfaceCapabilities¶

bool m_showSurfaceCapabilities { false };

variable m_capabilitiesString¶

std::string m_capabilitiesString;

Updated on 2025-07-08 at 12:01:11 +0000