Class Unity

Inheritance

Unity

Namespace:

Syntax

Methods

configureFunctionLogger

Declaration

unity.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)

Parameters

Type	Name	Description
String	functionName
Boolean	enableFunction
Boolean	enableParameters
Boolean	enableExecutionTime

getD3D11Device

See also:

• unity.getD3D11RenderTargetViewFromRenderBuffer
• unity.getD3D11ShaderResourceViewFromNativeTexture
• unity.getD3D11TextureFromNativeTexture
• unity.getD3D11TextureFromRenderBuffer

Declaration

unity.getD3D11Device() -> unity.ID3D11Device

Returns

Type	Description
ID3D11Device

getD3D11RenderTargetViewFromRenderBuffer

See also:

• unity.getD3D11Device
• unity.getD3D11ShaderResourceViewFromNativeTexture
• unity.getD3D11TextureFromNativeTexture
• unity.getD3D11TextureFromRenderBuffer

Declaration

unity.getD3D11RenderTargetViewFromRenderBuffer(surface) -> unity.ID3D11RenderTargetView

Parameters

Type	Name	Description
UnityRenderBuffer	surface

Returns

Type	Description
ID3D11RenderTargetView

getD3D11ShaderResourceViewFromNativeTexture

See also:

• unity.getD3D11Device
• unity.getD3D11RenderTargetViewFromRenderBuffer
• unity.getD3D11TextureFromNativeTexture
• unity.getD3D11TextureFromRenderBuffer

Declaration

unity.getD3D11ShaderResourceViewFromNativeTexture(texture) -> unity.ID3D11ShaderResourceView

Parameters

Type	Name	Description
UnityTextureID	texture

Returns

Type	Description
ID3D11ShaderResourceView

getD3D11TextureFromNativeTexture

See also:

• unity.getD3D11Device
• unity.getD3D11RenderTargetViewFromRenderBuffer
• unity.getD3D11ShaderResourceViewFromNativeTexture
• unity.getD3D11TextureFromRenderBuffer

Declaration

unity.getD3D11TextureFromNativeTexture(texture) -> unity.ID3D11Resource

Parameters

Type	Name	Description
UnityTextureID	texture

Returns

Type	Description
ID3D11Resource

getD3D11TextureFromRenderBuffer

See also:

• unity.getD3D11Device
• unity.getD3D11RenderTargetViewFromRenderBuffer
• unity.getD3D11ShaderResourceViewFromNativeTexture
• unity.getD3D11TextureFromNativeTexture

Declaration

unity.getD3D11TextureFromRenderBuffer(buffer) -> unity.ID3D11Resource

Parameters

Type	Name	Description
UnityRenderBuffer	buffer

Returns

Type	Description
ID3D11Resource

getDestroyFunction

See also:

• unity.getDrawFunction
• unity.getInitFunction

Declaration

unity.getDestroyFunction() -> unity.UnityRenderingEvent

Returns

Type	Description
UnityRenderingEvent

getDrawFunction

See also:

• unity.getDestroyFunction
• unity.getInitFunction

Declaration

unity.getDrawFunction() -> unity.UnityRenderingEventAndData

Returns

Type	Description
UnityRenderingEventAndData

getInitFunction

See also:

• unity.getDestroyFunction
• unity.getDrawFunction

Declaration

unity.getInitFunction() -> unity.UnityRenderingEvent

Returns

Type	Description
UnityRenderingEvent

asyncPick

Asynchronous function to pick in the current viewer

See also:

• unity.asyncResize
• unity.createUnityViewSession

Declaration

unity.asyncPick(session, x, y)

Parameters

Type	Name	Description
UnityViewSession	session
Int	x
Int	y

asyncResize

call this function when the texture has to be resized. the resize will take effect during the next render. This will send a ViewSessionResized event when done

See also:

• unity.asyncPick
• unity.createUnityViewSession

Declaration

unity.asyncResize(session, width, height)

Parameters

Type	Name	Description
UnityViewSession	session
Int	width	Viewer width
Int	height	Viewer height

createUnityViewSession

See also:

• unity.asyncPick
• unity.asyncResize

Declaration

unity.createUnityViewSession(width, height, graphicAPI, nbViews=1) -> unity.UnityViewSession

Parameters

Type	Name	Description
Int	width	Viewer width
Int	height	Viewer height
GraphicAPI	graphicAPI	Graphic api used by Unity
Int	nbViews	Nb views

Returns

Type	Description
UnityViewSession

getVulkanDevice

Declaration

unity.getVulkanDevice() -> unity.VulkanDevice

Returns

Type	Description
VulkanDevice

UnityViewSessionDestroyed

Declaration

def onUnityViewSessionDestroyed(session):
    pass

id = unity.addUnityViewSessionDestroyedCallback(onUnityViewSessionDestroyed)

...

unity.removeUnityViewSessionDestroyedCallback(id)

Parameters

Type	Name	Description
UnityViewSession	session	View session

UnityViewSessionHasPicked

Declaration

def onUnityViewSessionHasPicked(result, session):
    pass

id = unity.addUnityViewSessionHasPickedCallback(onUnityViewSessionHasPicked)

...

unity.removeUnityViewSessionHasPickedCallback(id)

Parameters

Type	Name	Description
PickResult	result	Result of the picking
UnityViewSession	session	View session

UnityViewSessionInitialized

Declaration

def onUnityViewSessionInitialized(session, viewer, gpuScene):
    pass

id = unity.addUnityViewSessionInitializedCallback(onUnityViewSessionInitialized)

...

unity.removeUnityViewSessionInitializedCallback(id)

Parameters

Type	Name	Description
UnityViewSession	session	View session
Viewer	viewer	Underlying viewer of the initialized view session
GPUScene	gpuScene	Underlying GPU scene of the initialized view session

UnityViewSessionResized

Declaration

def onUnityViewSessionResized(session):
    pass

id = unity.addUnityViewSessionResizedCallback(onUnityViewSessionResized)

...

unity.removeUnityViewSessionResizedCallback(id)

Parameters

Type	Name	Description
UnityViewSession	session	View session