Class Unity

Namespace

Unity

Methods

configureFunctionLogger

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

Parameters

functionName String

enableFunction Boolean

enableParameters Boolean

enableExecutionTime Boolean

getD3D11Device

unity.getD3D11Device() -> unity.ID3D11Device

Returns

ID3D11Device

getD3D11RenderTargetViewFromRenderBuffer

unity.getD3D11RenderTargetViewFromRenderBuffer(surface) -> unity.ID3D11RenderTargetView

Parameters

surface UnityRenderBuffer

Returns

ID3D11RenderTargetView

getD3D11ShaderResourceViewFromNativeTexture

unity.getD3D11ShaderResourceViewFromNativeTexture(texture) -> unity.ID3D11ShaderResourceView

Parameters

texture UnityTextureID

Returns

ID3D11ShaderResourceView

getD3D11TextureFromNativeTexture

unity.getD3D11TextureFromNativeTexture(texture) -> unity.ID3D11Resource

Parameters

texture UnityTextureID

Returns

ID3D11Resource

getD3D11TextureFromRenderBuffer

unity.getD3D11TextureFromRenderBuffer(buffer) -> unity.ID3D11Resource

Parameters

buffer UnityRenderBuffer

Returns

ID3D11Resource

getDestroyFunction

unity.getDestroyFunction() -> unity.UnityRenderingEvent

Returns

UnityRenderingEvent

getDrawFunction

unity.getDrawFunction() -> unity.UnityRenderingEventAndData

Returns

UnityRenderingEventAndData

getInitFunction

unity.getInitFunction() -> unity.UnityRenderingEvent

Returns

UnityRenderingEvent

asyncPick

Asynchronous function to pick in the current viewer

unity.asyncPick(session, x, y)

Parameters

session UnityViewSession

x Int

y Int

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

unity.asyncResize(session, width, height)

Parameters

session UnityViewSession

width Int

Viewer width

height Int

Viewer height

createUnityViewSession

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

Parameters

width Int

Viewer width

height Int

Viewer height

graphicAPI GraphicAPI

Graphic api used by Unity

nbViews Int

Nb views

Returns

UnityViewSession

getUnityViewSessionViewer

Returns the underlying viewer of the given view session

unity.getUnityViewSessionViewer(session) -> view.Viewer

Parameters

session UnityViewSession

Returns

Viewer

getVulkanDevice

unity.getVulkanDevice() -> unity.VulkanDevice

Returns

VulkanDevice

UnityViewSessionDestroyed

def onUnityViewSessionDestroyed(session):
    pass

id = unity.addUnityViewSessionDestroyedCallback(onUnityViewSessionDestroyed)

...

unity.removeUnityViewSessionDestroyedCallback(id)

Parameters

session UnityViewSession

View session

UnityViewSessionHasPicked

def onUnityViewSessionHasPicked(result, session):
    pass

id = unity.addUnityViewSessionHasPickedCallback(onUnityViewSessionHasPicked)

...

unity.removeUnityViewSessionHasPickedCallback(id)

Parameters

result PickResult

Result of the picking

session UnityViewSession

View session

UnityViewSessionInitialized

def onUnityViewSessionInitialized(session):
    pass

id = unity.addUnityViewSessionInitializedCallback(onUnityViewSessionInitialized)

...

unity.removeUnityViewSessionInitializedCallback(id)

Parameters

session UnityViewSession

View session

UnityViewSessionResized

def onUnityViewSessionResized(session):
    pass

id = unity.addUnityViewSessionResizedCallback(onUnityViewSessionResized)

...

unity.removeUnityViewSessionResizedCallback(id)

Parameters

session UnityViewSession

View session