from::GXBS::GXDrawTask Class Reference

Abstract graphics draw task base. More...

#include <draw.hpp>

Inheritance diagram for from::GXBS::GXDrawTask:

Public Types
enum	scene { HDR_SCENE , UI_SCENE }
	Whether the task should draw on top of the UI. More...

Public Member Functions
void	register_task ()
	Register the draw task, i.e. start its execution.
virtual void	draw ()=0
	The abstract method that is called whenever the task executes after being registered by from::GXBS::GXDrawTask::register_task.
scene	get_scene () const noexcept
	Get the scene, which selects the layer to draw on.
void	set_scene (scene new_scene) noexcept
	Set the scene object, which selects the layer to draw on.
ID3D12Device &	get_device () noexcept
	Get the ID3D12Device interface.
ID3D12RootSignature &	get_root_signature () noexcept
	Get the ID3D12RootSignature interface.
ID3D12CommandQueue &	get_command_queue () noexcept
	Get the ID3D12CommandQueue interface.
D3D12_CPU_DESCRIPTOR_HANDLE &	get_render_target_view () noexcept
	Get the render target view handle.
D3D12_CPU_DESCRIPTOR_HANDLE &	get_depth_stencil_view () noexcept
	Get the depth stencil view handle.
const D3D12_VIEWPORT &	get_viewport () noexcept
	Get the current viewport dimensions.
const D3D12_RECT &	get_scissor_rect () noexcept
	Get the scissor rect dimensions.
float	get_delta_time () noexcept
	Get the delta time of this frame.
int	get_times_called () noexcept
	Get how many times this draw task has been called.
Public Member Functions inherited from from::DLUT::DLReferenceCountObject
virtual void	deleter ()
	The deleter method to call when reference count reaches zero.
int	count () const noexcept
	Get number of references to object.
void	ref () noexcept
	Increment the object's reference count.
void	unref ()
	Unreference object; there cannot be more ref() calls than unref() calls.
Public Member Functions inherited from from::CS::CSEzTask
void	execute (FD4::FD4TaskData *data) final
	FD4::FD4TaskBase execute method that calls eztask_execute.
virtual LIBERAPI void	register_task (CSTaskGroup task_group)
	Register a task to be called in a specified task group.
virtual LIBERAPI void	free_task ()
	Free the task, suspending its execution after it has been registered.
LIBERAPI CSTaskGroup	get_task_group () const noexcept
	Get the task group this task is currently registered at.

Additional Inherited Members
Protected Member Functions inherited from from::DLUT::DLReferenceCountObject
	DLReferenceCountObject () noexcept=default
	Protected DLReferenceCountObject constructor.

Detailed Description

Abstract graphics draw task base.

Based on CS::CSEzTask , this task executes during the CS::CSTaskGroup::GraphicsStep once registered. Concrete classes that derive from it must implement the draw method, and may access DirectX 12 resources through other methods of this class.

Two layer options are provided by default, which determine if the D3D12 render target view returned by from::GXBS::GXDrawTask::get_render_target_view is above or below ELDEN RING's menu/UI.

See also

from::CS::CSEzTask

Member Enumeration Documentation

scene

enum from::GXBS::GXDrawTask::scene

Whether the task should draw on top of the UI.

HDR_SCENE (called HDRScene by the game): draw before the UI is composited onto the final render target.

UI_SCENE (called UIScene by the game): draw on top of the composited UI, but below any 3rd party overlays.

Member Function Documentation

draw()

virtual void from::GXBS::GXDrawTask::draw ( )

pure virtual

The abstract method that is called whenever the task executes after being registered by from::GXBS::GXDrawTask::register_task.

The DirectX 12 resources accessible through this class's methods are guaranteed to be initialized.

get_command_queue()

ID3D12CommandQueue & from::GXBS::GXDrawTask::get_command_queue ( )

inlinenoexcept

Get the ID3D12CommandQueue interface.

Returns

ID3D12CommandQueue& reference to the interface

get_delta_time()

float from::GXBS::GXDrawTask::get_delta_time ( )

inlinenoexcept

Get the delta time of this frame.

Returns

float delta time in seconds

get_depth_stencil_view()

D3D12_CPU_DESCRIPTOR_HANDLE & from::GXBS::GXDrawTask::get_depth_stencil_view ( )

inlinenoexcept

Get the depth stencil view handle.

Returns

D3D12_CPU_DESCRIPTOR_HANDLE& dsv handle

get_device()

ID3D12Device & from::GXBS::GXDrawTask::get_device ( )

inlinenoexcept

Get the ID3D12Device interface.

Guaranteed to be initialized when called from from::GXBS::GXDrawTask::draw

Returns

ID3D12Device& reference to the interface

get_render_target_view()

D3D12_CPU_DESCRIPTOR_HANDLE & from::GXBS::GXDrawTask::get_render_target_view ( )

inlinenoexcept

Get the render target view handle.

Returns

D3D12_CPU_DESCRIPTOR_HANDLE& rtv handle

get_root_signature()

ID3D12RootSignature & from::GXBS::GXDrawTask::get_root_signature ( )

inlinenoexcept

Get the ID3D12RootSignature interface.

Returns

ID3D12RootSignature& reference to the interface

get_scene()

scene from::GXBS::GXDrawTask::get_scene ( ) const

inlinenoexcept

Get the scene, which selects the layer to draw on.

Returns

scene layer selection enum value

get_scissor_rect()

const D3D12_RECT & from::GXBS::GXDrawTask::get_scissor_rect ( )

inlinenoexcept

Get the scissor rect dimensions.

Returns

const D3D12_RECT& reference to the scissor rectangle structure

get_times_called()

int from::GXBS::GXDrawTask::get_times_called ( )

inlinenoexcept

Get how many times this draw task has been called.

Returns

int times called

get_viewport()

const D3D12_VIEWPORT & from::GXBS::GXDrawTask::get_viewport ( )

inlinenoexcept

Get the current viewport dimensions.

Returns

const D3D12_VIEWPORT& reference to the viewport structure

set_scene()

void from::GXBS::GXDrawTask::set_scene ( scene  new_scene )

inlinenoexcept

Set the scene object, which selects the layer to draw on.

Parameters

new_scene

scene layer selection enum value to use

---

The documentation for this class was generated from the following file:

• include/graphics/draw.hpp