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

#include <frame_buffer.h>

Inheritance diagram for gfx::frame_buffer:
gfx::handle_impl< frame_buffer, frame_buffer_handle >

Public Member Functions

 frame_buffer ()=default
 
 frame_buffer (std::uint16_t _width, std::uint16_t _height, texture_format _format, std::uint32_t _texture_flags=BGFX_SAMPLER_U_CLAMP|BGFX_SAMPLER_V_CLAMP)
 
 frame_buffer (const std::vector< texture::ptr > &textures)
 
 frame_buffer (const std::vector< fbo_attachment > &textures)
 
 frame_buffer (void *_nwh, std::uint16_t _width, std::uint16_t _height, texture_format _format=texture_format::Count, texture_format _depth_format=texture_format::Count)
 
void populate (const std::vector< texture::ptr > &textures)
 
void populate (const std::vector< fbo_attachment > &textures)
 
auto get_size () const -> usize32_t
 
auto get_attachment (std::uint32_t index=0) const -> const fbo_attachment &
 
auto get_attachments () const -> const std::vector< fbo_attachment > &
 
auto get_texture (std::uint32_t index=0) const -> const gfx::texture::ptr &
 
auto get_attachment_count () const -> size_t
 
- Public Member Functions inherited from gfx::handle_impl< frame_buffer, frame_buffer_handle >
 ~handle_impl ()
 
void dispose ()
 
auto is_valid () const -> bool
 
auto native_handle () const -> frame_buffer_handle
 

Additional Inherited Members

- Public Types inherited from gfx::handle_impl< frame_buffer, frame_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< frame_buffer, frame_buffer_handle >
static auto invalid_handle () -> frame_buffer_handle
 
- Protected Attributes inherited from gfx::handle_impl< frame_buffer, frame_buffer_handle >
frame_buffer_handle handle_
 

Detailed Description

Definition at line 22 of file frame_buffer.h.

Constructor & Destructor Documentation

◆ frame_buffer() [1/5]

gfx::frame_buffer::frame_buffer ( )
default

◆ frame_buffer() [2/5]

gfx::frame_buffer::frame_buffer ( std::uint16_t _width,
std::uint16_t _height,
texture_format _format,
std::uint32_t _texture_flags = BGFX_SAMPLER_U_CLAMP | BGFX_SAMPLER_V_CLAMP )

Definition at line 8 of file frame_buffer.cpp.

◆ frame_buffer() [3/5]

gfx::frame_buffer::frame_buffer ( const std::vector< texture::ptr > & textures)

Definition at line 18 of file frame_buffer.cpp.

◆ frame_buffer() [4/5]

gfx::frame_buffer::frame_buffer ( const std::vector< fbo_attachment > & textures)

Definition at line 23 of file frame_buffer.cpp.

◆ frame_buffer() [5/5]

gfx::frame_buffer::frame_buffer ( void * _nwh,
std::uint16_t _width,
std::uint16_t _height,
texture_format _format = texture_format::Count,
texture_format _depth_format = texture_format::Count )

Member Function Documentation

◆ get_attachment()

auto gfx::frame_buffer::get_attachment ( std::uint32_t index = 0) const -> const fbo_attachment&
nodiscard

Definition at line 79 of file frame_buffer.cpp.

◆ get_attachment_count()

auto gfx::frame_buffer::get_attachment_count ( ) const -> size_t
nodiscard

Definition at line 95 of file frame_buffer.cpp.

◆ get_attachments()

auto gfx::frame_buffer::get_attachments ( ) const -> const std::vector<fbo_attachment>&
nodiscard

Definition at line 84 of file frame_buffer.cpp.

◆ get_size()

auto gfx::frame_buffer::get_size ( ) const -> usize32_t
nodiscard

Definition at line 74 of file frame_buffer.cpp.

◆ get_texture()

auto gfx::frame_buffer::get_texture ( std::uint32_t index = 0) const -> const gfx::texture::ptr&
nodiscard

Definition at line 90 of file frame_buffer.cpp.

◆ populate() [1/2]

void gfx::frame_buffer::populate ( const std::vector< fbo_attachment > & textures)

Definition at line 53 of file frame_buffer.cpp.

◆ populate() [2/2]

void gfx::frame_buffer::populate ( const std::vector< texture::ptr > & textures)

Definition at line 39 of file frame_buffer.cpp.


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