Kanzi  3.9.4
Kanzi Engine API
kanzi::Framebuffer::AttachmentPoint Struct Reference

AttachmentPoint. More...

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

Public Member Functions

 AttachmentPoint ()=default
 Default constructor. More...
 
 AttachmentPoint (RenderbufferSharedPtr renderbuffer)
 Constructor. More...
 
 AttachmentPoint (TextureSharedPtr texture)
 Constructor. More...
 
void clear ()
 Clears the internal state of the handle. More...
 
RenderbuffergetRenderbuffer () const
 Gets the renderbuffer in this attachment point. More...
 
TexturegetTexture () const
 Gets the texture in this attachment point. More...
 
void setRenderbuffer (RenderbufferSharedPtr renderbuffer)
 Sets this attachment point to texture status. More...
 
void setTexture (TextureSharedPtr texture)
 Sets this attachment point to texture status. More...
 
bool update (TextureSharedPtr texture, RenderbufferSharedPtr renderbuffer)
 Updates the renderbuffer/texture state. More...
 

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
renderbufferRenderbuffer to use.

◆ AttachmentPoint() [3/3]

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

Constructor.

Parameters
textureTexture 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
textureTexture target.
renderbufferRenderbuffer 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
textureTexture to use.

◆ setRenderbuffer()

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

Sets this attachment point to texture status.

Parameters
renderbufferRenderbuffer to use.

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