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

#import <BNBRenderList.h>

Inheritance diagram for BNBRenderList:

Instance Methods

(void) - setName:
 Set name of the render list. More...
 
(nonnull NSString *) - getName
 
(int64_t) - getTasksCount
 
(int32_t) - addTask:target:subGeoms:
 add render task to layer. More...
 
(void) - addBlitTargetToTask:taskIndex:
 add blit task to layer. More...
 
(nullable BNBLayer *) - getTaskLayer:
 return render rask layer, by render task index. More...
 
(nonnull NSArray< NSString * > *) - getTaskSubGeometries:
 return render selected task sub geometries. More...
 
(nullable BNBRenderTarget *) - getTaskTarget:
 return render rask render target, by render task index. More...
 
(void) - clear
 Remove all render tasks. More...
 

Class Methods

(nullable BNBRenderList *) + create:
 Fabric method for render_list creating. More...
 

Detailed Description

Definition at line 21 of file BNBRenderList.h.

Method Documentation

◆ addBlitTargetToTask:taskIndex:

- (void) addBlitTargetToTask: (nullable BNBRenderTarget *)  dst
taskIndex: (int32_t)  taskIndex 

add blit task to layer.

◆ addTask:target:subGeoms:

- (int32_t) addTask: (nullable BNBLayer *)  layer
target: (nullable BNBRenderTarget *)  target
subGeoms: (nullable NSArray< NSString * > *)  subGeoms 

add render task to layer.

Parameters
layer(layer): entities layer.
target(render_target): needed render target. Do not change if previous target was the same. (Target changing will trigger start/finish behavior.)
subGeoms(optional<list<string>>): if specified: only sub geometries from this list will be rendered.

◆ clear

- (void) clear

Remove all render tasks.

◆ create:

+ (nullable BNBRenderList *) create: (nonnull NSString *)  name

Fabric method for render_list creating.

Returns
created render list (render_list).

◆ getName

- (nonnull NSString *) getName
Returns
name (string) of the render list

◆ getTaskLayer:

- (nullable BNBLayer *) getTaskLayer: (int32_t)  taskIndex

return render rask layer, by render task index.

Throw if index >= tasks size.

Parameters
taskIndex(int): render task index.
Returns
task layer (layer)

◆ getTasksCount

- (int64_t) getTasksCount

◆ getTaskSubGeometries:

- (nonnull NSArray<NSString *> *) getTaskSubGeometries: (int32_t)  taskIndex

return render selected task sub geometries.

If list is empty - all sub geometries will be rendered

Parameters
taskIndex(int): render task index.
Returns
sub geometries list (list<string>): list of sub geometries to render

◆ getTaskTarget:

- (nullable BNBRenderTarget *) getTaskTarget: (int32_t)  taskIndex

return render rask render target, by render task index.

Throw if index >= tasks size.

Parameters
taskIndex(int): render task index.
Returns
task render target (render_target)

◆ setName:

- (void) setName: (nonnull NSString *)  name

Set name of the render list.

Parameters
name(string)

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