Package org.boxutil.base

Class BaseInstanceRenderData

java.lang.Object

org.boxutil.base.BaseRenderData

org.boxutil.base.BaseInstanceRenderData

All Implemented Interfaces:

InstanceRenderAPI, RenderDataAPI

Direct Known Subclasses:

BaseIlluminantData, BaseMIRenderData, DistortionEntity, FlareEntity

public abstract class BaseInstanceRenderData
extends BaseRenderData
implements InstanceRenderAPI

Field Summary

Fields

Modifier and Type	Field	Description
protected List<InstanceDataAPI>	instanceData
protected int	instanceRefreshIndex
protected int	instanceRefreshOffset
protected int	instanceRefreshSize
protected int	instanceRenderingCount
protected int	instanceRenderingOffset
protected float	instanceTimerOverride
protected boolean	mappingSubmit
protected MemoryBlock	memory
protected final boolean[]	needRefreshInstanceData

Fields inherited from class org.boxutil.base.BaseRenderData

autoSubmitDataBuffer, autoSubmitModelMat, autoSubmitPrimeMat, blendConfig, blendState, controlData, customData, globalTimer, hasDelete, isTimerPaused, layer, modelMatBuffer, modelMatrix, primeMatBuffer, primeMatrix, primeMatrixState, statePackageBuffer, sync_lock, timingWhenPaused

Constructor Summary

Constructors

Constructor	Description
BaseInstanceRenderData()

Method Summary

Modifier and Type	Method	Description
protected void	_packingInstanceData(ByteBuffer rawBuffer, int offset, InstanceType type, int index, int limit, boolean isFixed)
byte	addInstanceData(InstanceDataAPI instanceData)	Have size limit BoxConfigs.getMaxInstanceDataSize().
void	callRefreshInstanceData(boolean refresh)	When changed the instance data(Not fixed instance data), call it.
void	copyInstanceTimerOverride(InstanceRenderAPI renderData)
void	delete()
byte	getGlobalTimerState()
List<InstanceDataAPI>	getInstanceData()
MemoryBlock	getInstanceDataMemory()
int	getInstanceDataRefreshIndex()
int	getInstanceDataRefreshOffset()
int	getInstanceDataRefreshSize()
float	getInstanceTimerOverride()
int	getRenderingCount()
int	getRenderingOffset()
int	getValidInstanceDataCount()
void	glDraw()
boolean	haveValidInstanceData()
boolean	isAlwaysRefreshInstanceData()
boolean	isMappingInstanceSubmit()	Default value is false.
boolean	isNeedRefreshInstanceData()
void	mallocInstance(InstanceType target, int dataNum)	Make sure call it before call InstanceRenderAPI.submitInstance() when without valid memory.
void	resetInstanceData()	When call it, will reset data and delete related objects.
protected void	resetInstanceDataClient()
protected void	resetInstanceDataResource()
void	resetMemory()
void	resetMemory(MemoryBlock memory)	Unsafe operation.
void	setAlwaysRefreshInstanceData(boolean refresh)
byte	setInstanceData(List<InstanceDataAPI> instanceData)	For rendering a lots of entities (such as 10k+ entities) at once.
byte	setInstanceData(List<InstanceDataAPI> instanceData, float fadeIn, float full, float fadeOut)	Reset global timer by manual.
void	setInstanceDataRefreshAllFromCurrentIndex()
void	setInstanceDataRefreshIndex(int index)
void	setInstanceDataRefreshOffset(int targetIndex)
void	setInstanceDataRefreshSize(int size)
void	setInstanceTimerOverride(float alpha, byte state)	Override timer of all in-vRAM instance data to this value.
void	setMappingInstanceSubmit(boolean mappingMode)	NOTE: Ineffective if device was OpenGL 4.4+ supported, will force updating to persistent mapping buffer.
void	setRenderingAllInstanceFromCurrentOffset()
void	setRenderingCount(int num)
void	setRenderingOffset(int index)	Should reset the rendering count after that.
void	setSharedInstanceData(InstanceRenderAPI renderData)	Will always computes once for the same memory range.
void	submitInstance()	Use it when you changed the instance data.

Methods inherited from class org.boxutil.base.BaseRenderData

_deleteExc, _resetExc, _StatePackageStack, advanceGlobalTimer, appendToEntity, appendToEntity, appendToEntity, appendToEntity, entityType, getBlendAlphaDST, getBlendAlphaSRC, getBlendColorDST, getBlendColorSRC, getBlendEquation, getBlendState, getCampaignLayer, getCombatLayer, getControlData, getCustomData, getGlobalTimer, getGlobalTimerAlpha, getLayer, getModelMatrix, getModelMatrixBuffer, getPrimeMatrix, getPrimeMatrixBuffer, getPrimeMatrixState, hasDelete, initIdentityModelMatrix, initIdentityPrimeMatrix, isAutoSubmitEntityData, isAutoSubmitModelMatrix, isAutoSubmitPrimeMatrix, isGlobalTimerOnce, isGlobalTimerOver, isTimerPaused, isTimingWhenPaused, pickDataPackage_vec4, pickModelMatrixPackage_mat4, pickPrimeMatrixPackage_mat4, reset, setAdditiveBlend, setAutoSubmitEntityData, setAutoSubmitModelMatrix, setAutoSubmitPrimeMatrix, setBlendEquation, setBlendFunc, setBlendFuncSeparate, setControlData, setCustomData, setCustomPrimeMatrix, setDefaultCampaignLayer, setDefaultCombatLayer, setDisableBlend, setFacingScale, setGlobalTimer, setGlobalTimerOnce, setLayer, setLocation, setLocation, setLocation, setLocation, setModelMatrix, setNegativeBlend, setNonePrimeMatrix, setNormalBlend, setPerspectivePrimeMatrix, setPrimeMatrix, setRotateScale, setStateVanilla, setStateVanilla, setTimerPaused, setTimingWhenPaused, setVanillaPrimeMatrix, submitEntityData, submitModelMatrix, submitPrimeMatrix

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

instanceRefreshIndex

protected int instanceRefreshIndex

instanceRefreshOffset

protected int instanceRefreshOffset

instanceRefreshSize

protected int instanceRefreshSize

instanceRenderingCount

protected int instanceRenderingCount

instanceRenderingOffset

protected int instanceRenderingOffset

instanceTimerOverride

protected float instanceTimerOverride

memory

protected volatile MemoryBlock memory

needRefreshInstanceData

protected final boolean[] needRefreshInstanceData

mappingSubmit

protected boolean mappingSubmit

instanceData

protected List<InstanceDataAPI> instanceData

Constructor Details

BaseInstanceRenderData

public BaseInstanceRenderData()

Method Details

delete

public void delete()

Specified by:

delete in interface RenderDataAPI

Overrides:

delete in class BaseRenderData

glDraw

public void glDraw()

Specified by:

glDraw in interface RenderDataAPI

Overrides:

glDraw in class BaseRenderData

resetInstanceDataResource

protected void resetInstanceDataResource()

resetInstanceDataClient

protected void resetInstanceDataClient()

resetInstanceData

public void resetInstanceData()

When call it, will reset data and delete related objects.

A.K.A. free() for instance data resources.

Specified by:

resetInstanceData in interface InstanceRenderAPI

getInstanceData

public List<InstanceDataAPI> getInstanceData()

Specified by:

getInstanceData in interface InstanceRenderAPI

setInstanceData

public byte setInstanceData(@Nullable
 List<InstanceDataAPI> instanceData)

For rendering a lots of entities (such as 10k+ entities) at once.

For all render objects, location/facing/size/color/emissive/alpha data all form InstanceDataAPI, and overlay to RenderDataAPI implements.

Render count decided by List.size().

Have size limit, pick smallest from BoxConfigs.getMaxInstanceDataSize().

This entity attribute, MaterialData.getColor() and MaterialData.getEmissiveColor() both apply to each instance when rendering.

For model matrix, each instance is also derived from this entity.

Specified by:

setInstanceData in interface InstanceRenderAPI

Parameters:

instanceData - set to 'null' or empty 'List' -> clear, or a 'List' what isn't empty.

Returns:

returns BoxEnum.STATE_SUCCESS when success, return BoxEnum.STATE_SUCCESS when null list that set to empty list.

setInstanceData

public byte setInstanceData(@Nullable
 List<InstanceDataAPI> instanceData,
 float fadeIn,
 float full,
 float fadeOut)

Reset global timer by manual.

Similar to setInstanceData(List).

Specified by:

setInstanceData in interface InstanceRenderAPI

Returns:

returns BoxEnum.STATE_SUCCESS when success, return BoxEnum.STATE_FAILED when null list that set to empty list.

addInstanceData

public byte addInstanceData(@NotNull
 InstanceDataAPI instanceData)

Have size limit BoxConfigs.getMaxInstanceDataSize().

Specified by:

addInstanceData in interface InstanceRenderAPI

Returns:

returns BoxEnum.STATE_SUCCESS when success, return BoxEnum.STATE_FAILED when over limit.

_packingInstanceData

protected void _packingInstanceData(ByteBuffer rawBuffer,
 int offset,
 InstanceType type,
 int index,
 int limit,
 boolean isFixed)

submitInstance

public void submitInstance()

Description copied from interface: InstanceRenderAPI

Use it when you changed the instance data.

Should have reserved size for it, memory expand is an expensive operation.

Make sure has call InstanceRenderAPI.mallocInstance(InstanceType, int) when without valid memory.

Specified by:

submitInstance in interface InstanceRenderAPI

mallocInstance

public void mallocInstance(InstanceType target,
 int dataNum)

Description copied from interface: InstanceRenderAPI

Make sure call it before call InstanceRenderAPI.submitInstance() when without valid memory.

Specified by:

mallocInstance in interface InstanceRenderAPI

isMappingInstanceSubmit

public boolean isMappingInstanceSubmit()

Default value is false.

Specified by:

isMappingInstanceSubmit in interface InstanceRenderAPI

setMappingInstanceSubmit

public void setMappingInstanceSubmit(boolean mappingMode)

NOTE: Ineffective if device was OpenGL 4.4+ supported, will force updating to persistent mapping buffer.

For some very slight data, use glBufferSubData() may faster.

Besides, some devices(some ARM SoC) may slower with glMapBufferRange(), decided by the drive how implements it.

Specified by:

setMappingInstanceSubmit in interface InstanceRenderAPI

Parameters:

mappingMode - to controls whether submit use glMapBufferRange(), else use glBufferSubData().

isNeedRefreshInstanceData

public boolean isNeedRefreshInstanceData()

Specified by:

isNeedRefreshInstanceData in interface InstanceRenderAPI

isAlwaysRefreshInstanceData

public boolean isAlwaysRefreshInstanceData()

Specified by:

isAlwaysRefreshInstanceData in interface InstanceRenderAPI

callRefreshInstanceData

public void callRefreshInstanceData(boolean refresh)

When changed the instance data(Not fixed instance data), call it.

Specified by:

callRefreshInstanceData in interface InstanceRenderAPI

setAlwaysRefreshInstanceData

public void setAlwaysRefreshInstanceData(boolean refresh)

Specified by:

setAlwaysRefreshInstanceData in interface InstanceRenderAPI

haveValidInstanceData

public boolean haveValidInstanceData()

Specified by:

haveValidInstanceData in interface InstanceRenderAPI

getValidInstanceDataCount

public int getValidInstanceDataCount()

Specified by:

getValidInstanceDataCount in interface InstanceRenderAPI

getInstanceDataRefreshIndex

public int getInstanceDataRefreshIndex()

Specified by:

getInstanceDataRefreshIndex in interface InstanceRenderAPI

getInstanceDataRefreshOffset

public int getInstanceDataRefreshOffset()

Specified by:

getInstanceDataRefreshOffset in interface InstanceRenderAPI

getInstanceDataRefreshSize

public int getInstanceDataRefreshSize()

Specified by:

getInstanceDataRefreshSize in interface InstanceRenderAPI

setInstanceDataRefreshIndex

public void setInstanceDataRefreshIndex(int index)

Specified by:

setInstanceDataRefreshIndex in interface InstanceRenderAPI

Parameters:

index - will refresh instance data start from this index.

setInstanceDataRefreshOffset

public void setInstanceDataRefreshOffset(int targetIndex)

Specified by:

setInstanceDataRefreshOffset in interface InstanceRenderAPI

Parameters:

targetIndex - will refresh instance data to instance data index of memory.

setInstanceDataRefreshSize

public void setInstanceDataRefreshSize(int size)

Specified by:

setInstanceDataRefreshSize in interface InstanceRenderAPI

Parameters:

size - Will refresh instance data count.

setInstanceDataRefreshAllFromCurrentIndex

public void setInstanceDataRefreshAllFromCurrentIndex()

Specified by:

setInstanceDataRefreshAllFromCurrentIndex in interface InstanceRenderAPI

getRenderingCount

public int getRenderingCount()

Specified by:

getRenderingCount in interface InstanceRenderAPI

setRenderingCount

public void setRenderingCount(int num)

Specified by:

setRenderingCount in interface InstanceRenderAPI

getRenderingOffset

public int getRenderingOffset()

Specified by:

getRenderingOffset in interface InstanceRenderAPI

setRenderingOffset

public void setRenderingOffset(int index)

Should reset the rendering count after that.

Specified by:

setRenderingOffset in interface InstanceRenderAPI

setRenderingAllInstanceFromCurrentOffset

public void setRenderingAllInstanceFromCurrentOffset()

Specified by:

setRenderingAllInstanceFromCurrentOffset in interface InstanceRenderAPI

getInstanceDataMemory

public MemoryBlock getInstanceDataMemory()

Specified by:

getInstanceDataMemory in interface InstanceRenderAPI

setSharedInstanceData

public void setSharedInstanceData(InstanceRenderAPI renderData)

Will always computes once for the same memory range.

And if any rendering entity with not-full-range refresh, will only refresh the minimum range for them.

Specified by:

setSharedInstanceData in interface InstanceRenderAPI

resetMemory

public void resetMemory(MemoryBlock memory)

Unsafe operation.

Equivalent to:

 
 MemoryBlock old_mem = this.memory;
 if (old_mem) free(old_mem);
 this.memory = new_mem;
 
 

Specified by:

resetMemory in interface InstanceRenderAPI

resetMemory

public void resetMemory()

Specified by:

resetMemory in interface InstanceRenderAPI

getInstanceTimerOverride

public float getInstanceTimerOverride()

Specified by:

getInstanceTimerOverride in interface InstanceRenderAPI

setInstanceTimerOverride

public void setInstanceTimerOverride(float alpha,
 byte state)

Override timer of all in-vRAM instance data to this value.

Specified by:

setInstanceTimerOverride in interface InstanceRenderAPI

Parameters:

alpha - set less than 0 to disable override.

state - valid state: BoxEnum.TIMER_IN, BoxEnum.TIMER_FULL, BoxEnum.TIMER_OUT.

copyInstanceTimerOverride

public void copyInstanceTimerOverride(InstanceRenderAPI renderData)

Specified by:

copyInstanceTimerOverride in interface InstanceRenderAPI

getGlobalTimerState

public byte getGlobalTimerState()

Specified by:

getGlobalTimerState in interface RenderDataAPI

Overrides:

getGlobalTimerState in class BaseRenderData