Kanzi 4.0.0-beta2
kanzi::Framebuffer::AttachmentPoint::TextureContainer Class Reference

Container for weak texture reference. More...

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

Public Member Functions

size_t getFaceIndex () const
 Gets the face attachment index.
 
size_t getMipmapLevel () const
 Gets the mipmap attachment level.
 
TextureSharedPtr getSharedTexture () const
 Gets a shared reference to the contained texture.
 
bool matches (const TextureSharedPtr &texture, size_t faceIndex, size_t mipmapLevel) const
 Indicates whether the contained texture attachment matches given parameters.
 
TextureContaineroperator= (const TextureContainer &)=delete
 Deleted copy operator.
 
TextureContaineroperator= (TextureContainer &&other) noexcept
 Move operator.
 
 TextureContainer (const TextureContainer &)=delete
 Deleted copy constructor.
 
 TextureContainer (const TextureSharedPtr &texture, size_t faceIndex, size_t mipmapLevel)
 Constructor.
 
 TextureContainer (TextureContainer &&other) noexcept
 Move constructor.
 

Protected Attributes

size_t m_faceIndex
 Attachment face index.
 
size_t m_mipmapLevel
 Attachment mipmap level.
 
TextureWeakPtr m_texture
 Weak texture reference.
 

Detailed Description

Container for weak texture reference.

Constructor & Destructor Documentation

◆ TextureContainer() [1/3]

kanzi::Framebuffer::AttachmentPoint::TextureContainer::TextureContainer ( const TextureSharedPtr & texture,
size_t faceIndex,
size_t mipmapLevel )
inlineexplicit

Constructor.

Parameters
textureTexture referenced.
faceIndexAttachment face index.
mipmapLevelMipmap level.

◆ TextureContainer() [2/3]

kanzi::Framebuffer::AttachmentPoint::TextureContainer::TextureContainer ( TextureContainer && other)
inlinenoexcept

Move constructor.

Parameters
otherSource container.

◆ TextureContainer() [3/3]

kanzi::Framebuffer::AttachmentPoint::TextureContainer::TextureContainer ( const TextureContainer & )
delete

Deleted copy constructor.

Member Function Documentation

◆ operator=() [1/2]

TextureContainer & kanzi::Framebuffer::AttachmentPoint::TextureContainer::operator= ( TextureContainer && other)
inlinenoexcept

Move operator.

Parameters
otherSource container.
Returns
This container object.

◆ operator=() [2/2]

TextureContainer & kanzi::Framebuffer::AttachmentPoint::TextureContainer::operator= ( const TextureContainer & )
delete

Deleted copy operator.

◆ matches()

bool kanzi::Framebuffer::AttachmentPoint::TextureContainer::matches ( const TextureSharedPtr & texture,
size_t faceIndex,
size_t mipmapLevel ) const
inline

Indicates whether the contained texture attachment matches given parameters.

Parameters
textureTexture referenced.
faceIndexAttachment face index.
mipmapLevelMipmap level.
Returns
If the attachment is matching true, false otherwise.

◆ getSharedTexture()

TextureSharedPtr kanzi::Framebuffer::AttachmentPoint::TextureContainer::getSharedTexture ( ) const
inline

Gets a shared reference to the contained texture.

Returns
Shared reference to the contained texture or nullptr.

◆ getFaceIndex()

size_t kanzi::Framebuffer::AttachmentPoint::TextureContainer::getFaceIndex ( ) const
inline

Gets the face attachment index.

Returns
Attachment face index.

◆ getMipmapLevel()

size_t kanzi::Framebuffer::AttachmentPoint::TextureContainer::getMipmapLevel ( ) const
inline

Gets the mipmap attachment level.

Returns
Mipmap attachment level.

Member Data Documentation

◆ m_texture

TextureWeakPtr kanzi::Framebuffer::AttachmentPoint::TextureContainer::m_texture
protected

Weak texture reference.

◆ m_faceIndex

size_t kanzi::Framebuffer::AttachmentPoint::TextureContainer::m_faceIndex
protected

Attachment face index.

◆ m_mipmapLevel

size_t kanzi::Framebuffer::AttachmentPoint::TextureContainer::m_mipmapLevel
protected

Attachment mipmap level.


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