kanzi::Framebuffer::AttachmentPoint Struct Reference

AttachmentPoint. More...

#include <kanzi/core.ui/graphics2d/framebuffer.hpp>

Public Member Functions
	AttachmentPoint ()=default
	Default constructor.
	AttachmentPoint (RenderbufferSharedPtr renderbuffer)
	Constructor.
	AttachmentPoint (TextureSharedPtr texture)
	Constructor.
void	clear ()
	Clears the internal state of the handle.
Renderbuffer *	getRenderbuffer () const
	Gets the renderbuffer in this attachment point.
Texture *	getTexture () const
	Gets the texture in this attachment point.
void	setRenderbuffer (RenderbufferSharedPtr renderbuffer)
	Sets this attachment point to texture status.
void	setTexture (TextureSharedPtr texture)
	Sets this attachment point to texture status.
bool	update (TextureSharedPtr texture, RenderbufferSharedPtr renderbuffer)
	Updates the renderbuffer/texture state.

Detailed Description

AttachmentPoint.

Controls single attachment point within the framebuffer.

Since

Kanzi 3.9.0

Constructor & Destructor Documentation

AttachmentPoint() [1/3]

kanzi::Framebuffer::AttachmentPoint::AttachmentPoint ( )

explicitdefault

Default constructor.

AttachmentPoint() [2/3]

kanzi::Framebuffer::AttachmentPoint::AttachmentPoint ( RenderbufferSharedPtr renderbuffer )

inlineexplicit

Constructor.

Parameters

renderbuffer

Renderbuffer to use.

AttachmentPoint() [3/3]

kanzi::Framebuffer::AttachmentPoint::AttachmentPoint ( TextureSharedPtr texture )

inlineexplicit

Constructor.

Parameters

texture

Texture to use.

Member Function Documentation

getTexture()

Texture * kanzi::Framebuffer::AttachmentPoint::getTexture ( ) const

inline

Gets the texture in this attachment point.

Returns

Pointer to texture.

getRenderbuffer()

Renderbuffer * kanzi::Framebuffer::AttachmentPoint::getRenderbuffer ( ) const

inline

Gets the renderbuffer in this attachment point.

Returns

Pointer to renderbuffer.

clear()

void kanzi::Framebuffer::AttachmentPoint::clear ( )

inline

Clears the internal state of the handle.

After calling this function, the attachment point does not own any GPU resources.

update()

bool kanzi::Framebuffer::AttachmentPoint::update	(	TextureSharedPtr	texture,
		RenderbufferSharedPtr	renderbuffer )

Updates the renderbuffer/texture state.

Renderbuffer is favored over texture.

Parameters

texture	Texture target.
renderbuffer	Renderbuffer target.

Returns

If the state was changed true, otherwise false.

setTexture()

void kanzi::Framebuffer::AttachmentPoint::setTexture

(

TextureSharedPtr

texture

)

Sets this attachment point to texture status.

Parameters

texture

Texture to use.

setRenderbuffer()

void kanzi::Framebuffer::AttachmentPoint::setRenderbuffer

(

RenderbufferSharedPtr

renderbuffer

)

Sets this attachment point to texture status.

Parameters

renderbuffer

Renderbuffer to use.

---

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

• kanzi/core.ui/graphics2d/framebuffer.hpp