Raven::FramebufferSpecification Struct Reference

Configuration settings for creating or resizing a framebuffer. More...

#include <Framebuffer.h>

Public Attributes
float	Scale = 1.0f
	Scale relative to target surface.
u32	Width = 0
	Framebuffer width in pixels.
u32	Height = 0
	Framebuffer height in pixels.
Crux::vec4	ClearColor = {0, 0, 0, 1}
	Clear color used for color attachments.
float	DepthClearValue = 0.0f
	Depth clear value.
FramebufferAttachmentSpecification	Attachments
	Attachment specs.
u8	Samples = 1
	Multisample count.
bool	NoResize = false
	Prevent automatic resize.
bool	Blend = true
	Enable blending on framebuffer.
FramebufferBlendMode	BlendMode = FramebufferBlendMode::None
	Blending mode.
bool	SwapchainTarget = false
	True if used as swapchain target.
bool	Transfer = false
	Whether framebuffer participates in transfer operations.
Ref< Image2D >	ExistingImage
	Existing image to attach instead of creating new.
std::vector< u32 >	ExistingImageLayers
	Layers of the existing image to attach.
std::map< u32, Ref< Image2D > >	ExistingImages
	Attachment index to existing image map.
Ref< Framebuffer >	ExistingFramebuffer
	Existing framebuffer to attach.

Detailed Description

Configuration settings for creating or resizing a framebuffer.

Contains dimensions, clear colors, sample count, attachments, blending and swapchain flags, and references to existing images/framebuffers.

Member Data Documentation

Attachments

FramebufferAttachmentSpecification Raven::FramebufferSpecification::Attachments

Attachment specs.

Blend

bool Raven::FramebufferSpecification::Blend = true

Enable blending on framebuffer.

BlendMode

FramebufferBlendMode Raven::FramebufferSpecification::BlendMode = FramebufferBlendMode::None

Blending mode.

ClearColor

Crux::vec4 Raven::FramebufferSpecification::ClearColor = {0, 0, 0, 1}

Clear color used for color attachments.

DepthClearValue

float Raven::FramebufferSpecification::DepthClearValue = 0.0f

Depth clear value.

ExistingFramebuffer

Ref<Framebuffer> Raven::FramebufferSpecification::ExistingFramebuffer

Existing framebuffer to attach.

ExistingImage

Ref<Image2D> Raven::FramebufferSpecification::ExistingImage

Existing image to attach instead of creating new.

ExistingImageLayers

std::vector<u32> Raven::FramebufferSpecification::ExistingImageLayers

Layers of the existing image to attach.

ExistingImages

std::map<u32, Ref<Image2D> > Raven::FramebufferSpecification::ExistingImages

Attachment index to existing image map.

Height

u32 Raven::FramebufferSpecification::Height = 0

Framebuffer height in pixels.

NoResize

bool Raven::FramebufferSpecification::NoResize = false

Prevent automatic resize.

Samples

u8 Raven::FramebufferSpecification::Samples = 1

Multisample count.

Scale

float Raven::FramebufferSpecification::Scale = 1.0f

Scale relative to target surface.

SwapchainTarget

bool Raven::FramebufferSpecification::SwapchainTarget = false

True if used as swapchain target.

Transfer

bool Raven::FramebufferSpecification::Transfer = false

Whether framebuffer participates in transfer operations.

Width

u32 Raven::FramebufferSpecification::Width = 0

Framebuffer width in pixels.

---

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

• Illumine/src/Renderer/Framebuffer.h