Banuba SDK
Instance Methods | List of all members
BNBAttachment Class Reference

Class, represents render target attachment. More...

#import <BNBAttachment.h>

Inheritance diagram for BNBAttachment:

Instance Methods

(BNBAttachmentType) - getAttachmentType
 
(void) - setType:
 
(void) - setClearColor:
 
(nonnull BNBVec4 *) - getClearColor
 
(void) - setWidth:
 set attachment width More...
 
(void) - setHeight:
 set attachment height More...
 
(int32_t) - getWidth
 
(int32_t) - getHeight
 
(void) - setInfo:
 
(nonnull BNBAttachmentInfo *) - getInfo
 
(void) - setFormat:
 set attachment pixel format More...
 
(BNBPixelFormatType) - getFormat
 
(void) - setFilteringMode:
 set attachment texture filtering mode param mode (texture_filtering_mode) More...
 
(BNBTextureFilteringMode) - getFilteringMode
 
(nullable BNBImage *) - asImage
 

Detailed Description

Class, represents render target attachment.

Subclass of image

Definition at line 20 of file BNBAttachment.h.

Method Documentation

◆ asImage

- (nullable BNBImage *) asImage
Returns
upcast to base type

◆ getAttachmentType

- (BNBAttachmentType) getAttachmentType
Returns
attachment type (attachment_type). Can be color, or depth

◆ getClearColor

- (nonnull BNBVec4 *) getClearColor
Returns
attachment clear color (vec4)

◆ getFilteringMode

- (BNBTextureFilteringMode) getFilteringMode
Returns
filtering mode (texture_filtering_mode)

◆ getFormat

- (BNBPixelFormatType) getFormat
Returns
attachment pixel format

◆ getHeight

- (int32_t) getHeight
Returns
attachment height (int)

◆ getInfo

- (nonnull BNBAttachmentInfo *) getInfo

◆ getWidth

- (int32_t) getWidth
Returns
attachment width (int)

◆ setClearColor:

- (void) setClearColor: (nonnull BNBVec4 *)  color
Parameters
color(vec4). Also implisity set attachment load behaviour to clear.

◆ setFilteringMode:

- (void) setFilteringMode: (BNBTextureFilteringMode)  value

set attachment texture filtering mode param mode (texture_filtering_mode)

◆ setFormat:

- (void) setFormat: (BNBPixelFormatType)  format

set attachment pixel format

◆ setHeight:

- (void) setHeight: (int32_t)  value

set attachment height

Parameters
height(int)

◆ setInfo:

- (void) setInfo: (nonnull BNBAttachmentInfo *)  info

◆ setType:

- (void) setType: (BNBAttachmentType)  type
Parameters
type(attachment_type). Can be color, or depth

◆ setWidth:

- (void) setWidth: (int32_t)  value

set attachment width

Parameters
width(int)

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