gfx::uniform Struct Reference

#include <uniform.h>

Inheritance diagram for gfx::uniform:

Public Member Functions
	uniform ()=default
	~uniform ()
	uniform (const std::string &_name, uniform_type _type, std::uint16_t _num=1)
	uniform (handle_type_t _handle)
void	set_texture (uint8_t _stage, const gfx::frame_buffer *_handle, uint8_t _attachment=0, uint32_t _flags=std::numeric_limits< uint32_t >::max())
void	set_texture (uint8_t _stage, const gfx::texture *_texture, uint32_t _flags=std::numeric_limits< uint32_t >::max())
void	set_uniform (const void *_value, uint16_t _num=1)
Public Member Functions inherited from gfx::handle_impl< uniform, uniform_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 -> uniform_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
uniform_info	info
	Uniform info.

Additional Inherited Members
Public Types inherited from gfx::handle_impl< uniform, uniform_handle >
using	ptr
using	uptr
using	weak_ptr
using	handle_type_t
using	base_type
Static Public Member Functions inherited from gfx::handle_impl< uniform, uniform_handle >
static auto	invalid_handle () -> uniform_handle
Protected Member Functions inherited from gfx::handle_impl< uniform, uniform_handle >
auto	fallback_handle () const -> uniform_handle
auto	get_fallback_handle () const -> uniform_handle
void	make_evictable (std::uint64_t gpu_bytes, std::function< bool(uniform &)> restore_fn, evict_class cls=evict_class::evictable)
void	make_evictable_deferred (std::uint64_t gpu_bytes, std::function< bool(uniform &)> restore_fn, evict_class cls=evict_class::evictable)
Protected Attributes inherited from gfx::handle_impl< uniform, uniform_handle >
uniform_handle	handle_
std::function< bool(uniform &)>	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 18 of file uniform.h.

Constructor & Destructor Documentation

uniform() [1/3]

gfx::uniform::uniform ( )

default

~uniform()

gfx::uniform::~uniform

(

)

Definition at line 90 of file uniform.cpp.

uniform() [2/3]

gfx::uniform::uniform	(	const std::string &	_name,
		uniform_type	_type,
		std::uint16_t	_num = 1 )

Definition at line 76 of file uniform.cpp.

uniform() [3/3]

gfx::uniform::uniform

(

handle_type_t

_handle

)

Definition at line 83 of file uniform.cpp.

Member Function Documentation

set_texture() [1/2]

void gfx::uniform::set_texture	(	uint8_t	_stage,
		const gfx::frame_buffer *	_handle,
		uint8_t	_attachment = 0,
		uint32_t	_flags = std::numeric_limits<uint32_t>::max() )

Definition at line 99 of file uniform.cpp.

set_texture() [2/2]

void gfx::uniform::set_texture	(	uint8_t	_stage,
		const gfx::texture *	_texture,
		uint32_t	_flags = std::numeric_limits<uint32_t>::max() )

Definition at line 112 of file uniform.cpp.

set_uniform()

void gfx::uniform::set_uniform	(	const void *	_value,
		uint16_t	_num = 1 )

Definition at line 124 of file uniform.cpp.

Member Data Documentation

info

uniform_info gfx::uniform::info

Uniform info.

Definition at line 78 of file uniform.h.

---

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

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