Unity
Python API functions
Read time 3 minutesLast updated 8 months ago
configureFunctionLogger
unity.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)
Parameters
Type | Name | Description |
|---|---|---|
| String | functionName | |
| Boolean | enableFunction | |
| Boolean | enableParameters | |
| Boolean | enableExecutionTime |
Direct3D
getD3D11Device
unity.getD3D11Device() -> unity.ID3D11Device
Returns
Type | Name | Description |
|---|---|---|
| ID3D11Device | device |
See also:
- unity.getD3D11RenderTargetViewFromRenderBuffer
- unity.getD3D11ShaderResourceViewFromNativeTexture
- unity.getD3D11TextureFromNativeTexture
- unity.getD3D11TextureFromRenderBuffer
getD3D11RenderTargetViewFromRenderBuffer
unity.getD3D11RenderTargetViewFromRenderBuffer(surface) -> unity.ID3D11RenderTargetView
Parameters
Type | Name | Description |
|---|---|---|
| UnityRenderBuffer | surface |
Returns
Type | Name | Description |
|---|---|---|
| ID3D11RenderTargetView | rtv |
See also:
- unity.getD3D11Device
- unity.getD3D11ShaderResourceViewFromNativeTexture
- unity.getD3D11TextureFromNativeTexture
- unity.getD3D11TextureFromRenderBuffer
getD3D11ShaderResourceViewFromNativeTexture
unity.getD3D11ShaderResourceViewFromNativeTexture(texture) -> unity.ID3D11ShaderResourceView
Parameters
Type | Name | Description |
|---|---|---|
| UnityTextureID | texture |
Returns
Type | Name | Description |
|---|---|---|
| ID3D11ShaderResourceView | srv |
See also:
- unity.getD3D11Device
- unity.getD3D11RenderTargetViewFromRenderBuffer
- unity.getD3D11TextureFromNativeTexture
- unity.getD3D11TextureFromRenderBuffer
getD3D11TextureFromNativeTexture
unity.getD3D11TextureFromNativeTexture(texture) -> unity.ID3D11Resource
Parameters
Type | Name | Description |
|---|---|---|
| UnityTextureID | texture |
Returns
Type | Name | Description |
|---|---|---|
| ID3D11Resource | dxTexture |
See also:
- unity.getD3D11Device
- unity.getD3D11RenderTargetViewFromRenderBuffer
- unity.getD3D11ShaderResourceViewFromNativeTexture
- unity.getD3D11TextureFromRenderBuffer
getD3D11TextureFromRenderBuffer
unity.getD3D11TextureFromRenderBuffer(buffer) -> unity.ID3D11Resource
Parameters
Type | Name | Description |
|---|---|---|
| UnityRenderBuffer | buffer |
Returns
Type | Name | Description |
|---|---|---|
| ID3D11Resource | dxTexture |
See also:
- unity.getD3D11Device
- unity.getD3D11RenderTargetViewFromRenderBuffer
- unity.getD3D11ShaderResourceViewFromNativeTexture
- unity.getD3D11TextureFromNativeTexture
Unity Pugin Event Functions
getDestroyFunction
unity.getDestroyFunction() -> unity.UnityRenderingEvent
Returns
Type | Name | Description |
|---|---|---|
| UnityRenderingEvent | destroyFunction |
See also:
getDrawFunction
unity.getDrawFunction() -> unity.UnityRenderingEventAndData
Returns
Type | Name | Description |
|---|---|---|
| UnityRenderingEventAndData | drawFunction |
See also:
getInitFunction
unity.getInitFunction() -> unity.UnityRenderingEvent
Returns
Type | Name | Description |
|---|---|---|
| UnityRenderingEvent | initFunction |
See also:
Unity View Session
asyncPick
Asynchronous function to pick in the current viewer.
unity.asyncPick(session, x, y)
Parameters
Type | Name | Description |
|---|---|---|
| UnityViewSession | session | |
| Int | x | |
| Int | y |
See also:
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
Type | Name | Description |
|---|---|---|
| UnityViewSession | session | |
| Int | width | Viewer width. |
| Int | height | Viewer height. |
See also:
createUnityViewSession
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 | Name | Description |
|---|---|---|
| UnityViewSession | session |
See also:
Vulkan
getVulkanDevice
unity.getVulkanDevice() -> unity.VulkanDevice
Returns
Type | Name | Description |
|---|---|---|
| VulkanDevice | vkDevice |