Package com.banuba.sdk.scene

Interface RenderList

All Known Implementing Classes:

RenderList.CppProxy

public interface RenderList

A list of render task. Every task consist of entites layer to draw, render target in which draw, and optional list of sub geomteries names. Cannot be changed after effect activation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RenderList.CppProxy

Method Summary

Modifier and Type	Method	Description
void	addBlitTargetToTask(RenderTarget dst, int taskIndex)	add blit task to layer.
int	addTask(Layer layer, RenderTarget target, java.util.ArrayList<java.lang.String> subGeoms)	add render task to layer.
void	clear()	Remove all render tasks.
static RenderList	create(java.lang.String name)	Fabric method for render_list creating.
java.lang.String	getName()
Layer	getTaskLayer(int taskIndex)	return render rask layer, by render task index.
long	getTasksCount()
java.util.ArrayList<java.lang.String>	getTaskSubGeometries(int taskIndex)	return render selected task sub geometries.
RenderTarget	getTaskTarget(int taskIndex)	return render rask render target, by render task index.
void	setName(java.lang.String name)	Set name of the render list

Method Detail

setName

void setName(@NonNull
             java.lang.String name)

Set name of the render list

Parameters:

name - (string)

getName

@NonNull
java.lang.String getName()

Returns:

name (string) of the render list

getTasksCount

long getTasksCount()

addTask

int addTask(@Nullable
            Layer layer,
            @Nullable
            RenderTarget target,
            @Nullable
            java.util.ArrayList<java.lang.String> 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>): if specified: only sub geometries from this list will be rendered.

addBlitTargetToTask

void addBlitTargetToTask(@Nullable
                         RenderTarget dst,
                         int taskIndex)

add blit task to layer.

getTaskLayer

@Nullable
Layer getTaskLayer(int taskIndex)

return render rask layer, by render task index. Throw if index >= tasks size.

Parameters:

taskIndex - (int): render task index.

Returns:

task layer (layer)

getTaskSubGeometries

@NonNull
java.util.ArrayList<java.lang.String> getTaskSubGeometries(int 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): list of sub geometries to render

getTaskTarget

@Nullable
RenderTarget getTaskTarget(int 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)

clear

void clear()

Remove all render tasks.

create

@Nullable
static RenderList create(@NonNull
                         java.lang.String name)

Fabric method for render_list creating.

Returns:

created render list (render_list).