Unravel Engine C++ Reference
Loading...
Searching...
No Matches
gfx::index_buffer Struct Reference

#include <index_buffer.h>

Inheritance diagram for gfx::index_buffer:
gfx::handle_impl< index_buffer, index_buffer_handle > gfx::ievictable

Public Member Functions

 index_buffer ()=default
 
 index_buffer (const memory_view *_mem, std::uint16_t _flags=BGFX_BUFFER_NONE)
 
- Public Member Functions inherited from gfx::handle_impl< index_buffer, index_buffer_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 -> index_buffer_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
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ index_buffer() [1/2]

gfx::index_buffer::index_buffer ( )
default

◆ index_buffer() [2/2]

gfx::index_buffer::index_buffer ( const memory_view * _mem,
std::uint16_t _flags = BGFX_BUFFER_NONE )

Definition at line 6 of file index_buffer.cpp.


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