gfx::shader Struct Reference

#include <shader.h>

Inheritance diagram for gfx::shader:

Public Member Functions
	shader ()=default
	shader (const std::string &path)
	shader (const memory_view *_mem)
	shader (const embedded_shader *_es, const char *name)
	shader (handle_type_t hndl)
Public Member Functions inherited from gfx::handle_impl< shader, shader_handle >
	handle_impl ()=default
	handle_impl (const handle_impl &)=delete
	handle_impl (handle_impl &&)=delete
auto	operator= (const handle_impl &) -> handle_impl &=delete
auto	operator= (handle_impl &&) -> handle_impl &=delete
	~handle_impl () override
void	dispose ()
auto	is_valid () const -> bool
auto	native_handle () const -> shader_handle
void	set_name (const hpp::string_view &_name)
auto	on_evict () -> std::uint64_t override
	Release the GPU handle. Returns the number of GPU bytes freed. Must be idempotent.
auto	on_restore () -> bool override
	Recreate the GPU handle from the CPU backing. Returns true on success.
auto	gpu_size () const -> std::uint64_t override
	Approximate GPU footprint of the resource in bytes.
Public Member Functions inherited from gfx::ievictable
	ievictable ()=default
	ievictable (const ievictable &)=delete
auto	operator= (const ievictable &) -> ievictable &=delete
	ievictable (ievictable &&)=delete
auto	operator= (ievictable &&) -> ievictable &=delete
virtual	~ievictable ()=default
auto	get_evict_class () const -> evict_class
auto	get_evict_state () const -> evict_state
auto	get_last_use_frame () const -> std::uint64_t
auto	get_use_count () const -> std::uint64_t
void	touch () const noexcept

Public Attributes
std::vector< std::shared_ptr< uniform > >	uniforms
	Uniforms for this shader.

Additional Inherited Members
Public Types inherited from gfx::handle_impl< shader, shader_handle >
using	ptr
using	uptr
using	weak_ptr
using	handle_type_t
using	base_type
Static Public Member Functions inherited from gfx::handle_impl< shader, shader_handle >
static auto	invalid_handle () -> shader_handle
Protected Member Functions inherited from gfx::handle_impl< shader, shader_handle >
auto	fallback_handle () const -> shader_handle
auto	get_fallback_handle () const -> shader_handle
void	make_evictable (std::uint64_t gpu_bytes, std::function< bool(shader &)> restore_fn, evict_class cls=evict_class::evictable)
void	make_evictable_deferred (std::uint64_t gpu_bytes, std::function< bool(shader &)> restore_fn, evict_class cls=evict_class::evictable)
Protected Attributes inherited from gfx::handle_impl< shader, shader_handle >
shader_handle	handle_
std::function< bool(shader &)>	restore_fn_
std::uint64_t	gpu_size_
Protected Attributes inherited from gfx::ievictable
std::uint64_t	last_use_frame_ {0}
	Frame the resource was last used on (heuristic, written from touch).
std::uint64_t	use_count_ {0}
	Number of times the resource was used (heuristic, written from touch).
evict_state	evict_state_ {evict_state::resident}
	Current residency state. Written by the owning resource during evict/restore.
evict_class	evict_class_ {evict_class::non_evictable}
	Eligibility class. Set once when the resource opts into eviction.

Detailed Description

Definition at line 9 of file shader.h.

Constructor & Destructor Documentation

shader() [1/5]

gfx::shader::shader ( )

default

shader() [2/5]

gfx::shader::shader

(

const std::string &

path

)

Definition at line 6 of file shader.cpp.

shader() [3/5]

gfx::shader::shader

(

const memory_view *

_mem

)

Definition at line 11 of file shader.cpp.

shader() [4/5]

gfx::shader::shader	(	const embedded_shader *	_es,
		const char *	name )

Definition at line 15 of file shader.cpp.

shader() [5/5]

gfx::shader::shader

(

handle_type_t

hndl

)

Definition at line 20 of file shader.cpp.

Member Data Documentation

uniforms

std::vector<std::shared_ptr<uniform> > gfx::shader::uniforms

Uniforms for this shader.

Definition at line 18 of file shader.h.

---

The documentation for this struct was generated from the following files:

• engine/core/graphics/shader.h
• engine/core/graphics/shader.cpp