BNBRenderList
Objective-C
@interface BNBRenderList : NSObject
/**
*Fabric method for render_list creating.
*@return created render list (render_list).
*/
+ (nullable BNBRenderList *)create:(nonnull NSString *)name;
/**
*Set name of the render list
*@param name (string)
*/
- (void)setName:(nonnull NSString *)name;
/**@return name (string) of the render list */
- (nonnull NSString *)getName;
- (int64_t)getTasksCount;
/**
*add render task to layer.
*@param layer (layer): entities layer.
*@param target (render_target): needed render target. Do not change if previous target was the same. (Target changing will trigger start/finish behavior.)
*@param subGeoms (optional<list<string>>): if specified: only sub geometries from this list will be rendered.
*/
- (int32_t)addTask:(nullable BNBLayer *)layer
target:(nullable BNBRenderTarget *)target
subGeoms:(nullable NSArray<NSString *> *)subGeoms;
/**add blit task to layer. */
- (void)addBlitTargetToTask:(nullable BNBRenderTarget *)dst
taskIndex:(int32_t)taskIndex;
/**
*return render rask layer, by render task index. Throw if index >= tasks size.
*@param taskIndex (int): render task index.
*@return task layer (layer)
*/
- (nullable BNBLayer *)getTaskLayer:(int32_t)taskIndex;
/**
*return render selected task sub geometries. If list is empty - all sub geometries will be rendered
*@param taskIndex (int): render task index.
*@return sub geometries list (list<string>): list of sub geometries to render
*/
- (nonnull NSArray<NSString *> *)getTaskSubGeometries:(int32_t)taskIndex;
/**
*return render rask render target, by render task index. Throw if index >= tasks size.
*@param taskIndex (int): render task index.
*@return task render target (render_target)
*/
- (nullable BNBRenderTarget *)getTaskTarget:(int32_t)taskIndex;
/**Remove all render tasks. */
- (void)clear;
@end
Swift
class BNBRenderList : NSObject
Undocumented
-
Fabric method for render_list creating.
Declaration
Objective-C
+ (nullable BNBRenderList *)create:(nonnull NSString *)name;
Swift
class func create(_ name: String) -> BNBRenderList?
Return Value
created render list (render_list).
-
Set name of the render list
Declaration
Objective-C
- (void)setName:(nonnull NSString *)name;
Swift
func setName(_ name: String)
Parameters
name
(string)
-
Declaration
Objective-C
- (nonnull NSString *)getName;
Swift
func getName() -> String
Return Value
name (string) of the render list
-
Undocumented
Declaration
Objective-C
- (int64_t)getTasksCount;
Swift
func getTasksCount() -> Int64
-
add render task to layer.
Declaration
Objective-C
- (int32_t)addTask:(nullable BNBLayer *)layer target:(nullable BNBRenderTarget *)target subGeoms:(nullable NSArray<NSString *> *)subGeoms;
Swift
func addTask(_ layer: BNBLayer?, target: BNBRenderTarget?, subGeoms: [String]?) -> Int32
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
- >): if specified: only sub geometries from this list will be rendered.
-
add blit task to layer.
Declaration
Objective-C
- (void)addBlitTargetToTask:(nullable BNBRenderTarget *)dst taskIndex:(int32_t)taskIndex;
Swift
func addBlitTarget(toTask dst: BNBRenderTarget?, taskIndex: Int32)
-
return render selected task sub geometries. If list is empty - all sub geometries will be rendered
Declaration
Objective-C
- (nonnull NSArray<NSString *> *)getTaskSubGeometries:(int32_t)taskIndex;
Swift
func getTaskSubGeometries(_ taskIndex: Int32) -> [String]
Parameters
taskIndex
(int): render task index.
Return Value
sub geometries list (list
): list of sub geometries to render -
return render rask render target, by render task index. Throw if index >= tasks size.
Declaration
Objective-C
- (nullable BNBRenderTarget *)getTaskTarget:(int32_t)taskIndex;
Swift
func getTaskTarget(_ taskIndex: Int32) -> BNBRenderTarget?
Parameters
taskIndex
(int): render task index.
Return Value
task render target (render_target)
-
Remove all render tasks.
Declaration
Objective-C
- (void)clear;
Swift
func clear()