Kanzi Engine API
kanzi::Framebuffer::Attachment Struct Reference

Framebuffer attachment settings. More...

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

Public Member Functions

 Attachment ()
 
 Attachment (TextureSharedPtr texture)
 Construct Attachment from 2D Texture base level image. More...
 
 Attachment (TextureSharedPtr texture, unsigned int mipmapLevel)
 Construct Attachment from a 2D texture. More...
 
 Attachment (TextureSharedPtr texture, Surface::Face face, unsigned int mipmapLevel)
 Construct Attachment from a 2D texture. More...
 
 Attachment (RenderbufferSharedPtr renderbuffer)
 Construct Attachment from Renderbuffer. More...
 

Public Attributes

Surface::Face face
 For cubemap textures, the cubemap face to use. More...
 
unsigned int mipmapLevel
 Mipmap level to use, for Textures. More...
 
SurfaceSharedPtr surface
 Surface. This can be either Texture or Renderbuffer. More...
 

Detailed Description

Framebuffer attachment settings.

Constructor & Destructor Documentation

kanzi::Framebuffer::Attachment::Attachment ( )
explicit
kanzi::Framebuffer::Attachment::Attachment ( TextureSharedPtr  texture)
explicit

Construct Attachment from 2D Texture base level image.

Parameters
textureTexture to use.
kanzi::Framebuffer::Attachment::Attachment ( TextureSharedPtr  texture,
unsigned int  mipmapLevel 
)
explicit

Construct Attachment from a 2D texture.

Parameters
textureTexture to use.
mipmapLevelMipmap level of texture to use.
kanzi::Framebuffer::Attachment::Attachment ( TextureSharedPtr  texture,
Surface::Face  face,
unsigned int  mipmapLevel 
)
explicit

Construct Attachment from a 2D texture.

Parameters
textureTexture to use.
mipmapLevelMipmap level of texture to use.
kanzi::Framebuffer::Attachment::Attachment ( RenderbufferSharedPtr  renderbuffer)
explicit

Construct Attachment from Renderbuffer.

Parameters
renderbufferRenderbuffer to use.

Member Data Documentation

SurfaceSharedPtr kanzi::Framebuffer::Attachment::surface

Surface. This can be either Texture or Renderbuffer.

Surface::Face kanzi::Framebuffer::Attachment::face

For cubemap textures, the cubemap face to use.

unsigned int kanzi::Framebuffer::Attachment::mipmapLevel

Mipmap level to use, for Textures.


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