docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ViewInterface

    Inheritance
    object
    Interface
    ViewInterface
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Pixyz.View
    Assembly: Unity.Pixyz.SDKPlus.Editor.dll
    Syntax
    public class ViewInterface : Interface

    Methods

    Name Description
    AddAfterFramebufferCreateCallback(AfterFramebufferCreateDelegate, IntPtr)
    AddAfterViewerPropertyChangedCallback(AfterViewerPropertyChangedDelegate, IntPtr)
    AddAnimationPausedOrStoppedCallback(AnimationPausedOrStoppedDelegate, IntPtr)
    AddAnimationPlayedOrResumedCallback(AnimationPlayedOrResumedDelegate, IntPtr)
    AddAnimationPlayingStatusChangedCallback(AnimationPlayingStatusChangedDelegate, IntPtr)
    AddBeforeFramebufferDeleteCallback(BeforeFramebufferDeleteDelegate, IntPtr)
    AddBeforeViewerPropertyChangedCallback(BeforeViewerPropertyChangedDelegate, IntPtr)
    AddGPUScene(int, int)

    Add a GPU scene to a viewer

    ApplyPlayingAnimations(ulong)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    apply the animations

    ConfigureFunctionLogger(string, bool, bool, bool)
    CreateGPUScene(OccurrenceList, bool, bool)
    CreateStreamedViewer(int, int, EncoderSettings, bool, WebRTCInfo?)

    create a viewer for streaming

    CreateViewer(int, int, GraphicsContext, int)

    Create a new viewer

    DestroyContext()

    Destroy the Vulkan instance. All existing viewers and gpuScenes will also be destroyed and all view module properties will be reset

    DestroyGPUScene(int)
    DestroyViewer(int)
    DrawCappingPlane(uint)

    Create an occurrence that holds the mesh of the surfaces that have been cut by the cutting plane

    FitCamera(Point3, CameraType, double, int, OccurrenceList)

    Set the viewer matrices to adjust the camera to the scene

    GetAnimationPlayerInfo(uint)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    packs all AnimationPlayer-related info about an animation in an object

    GetAutoClipping(int, Point3)

    Automatically compute the near and far planes depending on the scene

    GetCameraFrontAxis(int, uint)

    Get the front axis of the nth view matrix of a given viewer

    GetCameraPosition(int, uint)

    Get the position of the nth view matrix of a given viewer

    GetCameraRightAxis(int, uint)

    Get the right axis of the nth view matrix of a given viewer

    GetCameraUpAxis(int, uint)

    Get the up axis of the nth view matrix of a given viewer

    GetCompositedImage(int)
    GetD3D11Texture(RenderMap, int)
    GetGLTextureHandle(RenderMap, int)
    GetGlobalGPUScene()

    Returns (and create if it does not exist) a global GPU scene (with the scene root) to be used commonly by several clients

    GetLastAABB(int, int)

    Return the lastAABB computed during a frame drawing, requires the viewer property ComputeLastAABB to be True

    GetLastError()
    GetOccurrenceIndex(uint, int)

    Returns the occurrence index in the viewer buffers. Can be used for mapping an index retrieved in a GLTextureHandle id map.

    GetRenderMapImage(int, RenderMap)
    GetSceneIndex(int, int)

    Returns the GPU scene index in the viewer buffers. Can be used for mapping an index retrieved in a GLTextureHandle id map.

    GetViewerMatrices(int)
    GetViewerProperty(string, int)

    Get a viewer property value

    GetViewerPropertyInfo(string, int)

    Get a viewer property info

    GetViewerSize(int)

    Retrieve the viewport size of a viewer

    GetViewerStats(int)

    Returns the number of rendered occurrences and triangles. (Warning: this function does not handle isolate nor invertVisibility viewer property)

    GetVulkanTexture(RenderMap, int)
    InvertSelectPrimitives(int, int, int, int, PrimitiveSelectionType, int)

    Invert the selection of the primitives (polygons, surfaces) contained in the given rectangle

    IsAnimationPlaying(uint)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    is this animation playing?

    ListViewerProperties(int)

    Get the list of viewer properties

    LockGPUSceneUpdate(int)

    Lock the mutex that ensure no update of the gpu scene is done between lock/unlock

    LockGPUScenesUpdate(GPUSceneList)

    Lock the mutex that ensure no update of multiple gpu scenes is done between lock/unlock

    PauseAllAnimation()

    WARNING: this function is tagged as 'EXPERIMENTAL'
    pauses all animations

    PauseAnimation(uint)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    pauses an animation

    Pick(int, int, int)
    PickRectangle(int, int, int, int, int, bool)
    PlayAnimation(uint, double, bool)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    plays an animation

    RefreshViewer(int)

    Refresh the viewer

    RemoveAfterFramebufferCreateCallback(uint)
    RemoveAfterViewerPropertyChangedCallback(uint)
    RemoveAnimationPausedOrStoppedCallback(uint)
    RemoveAnimationPlayedOrResumedCallback(uint)
    RemoveAnimationPlayingStatusChangedCallback(uint)
    RemoveBeforeFramebufferDeleteCallback(uint)
    RemoveBeforeViewerPropertyChangedCallback(uint)
    RemoveGPUScene(int, int)

    Remove a viewer root

    ResizeStreamedViewer(int, int, int, EncoderSettings)
    ResizeViewer(int, int, int)
    ResumeAllAnimation()

    WARNING: this function is tagged as 'EXPERIMENTAL'
    resumes all animations

    ResumeAnimation(uint)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    resumes an animation

    SelectPrimitives(int, int, int, int, PrimitiveSelectionType, int)

    Select the primitives (polygons, surfaces) contained in the given rectangle

    SetAnimationFrame(uint, ulong)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    set animation's current frame

    SetAnimationLoop(uint, bool)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    set animation's looping status

    SetAnimationSpeed(uint, double)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    set animation's playing speed

    SetDefaultViewerId(int)

    Set default viewer id. This viewer will be used in other functions taking a Viewer as a parameter. Useful if a viewer needs to be shared across different contexts.

    SetViewerMatrices(Matrix4List, Matrix4List, Point2, int)
    SetViewerProperty(string, string, int)

    Set a viewer property value

    StartRecording(string, int, EncoderSettings)

    record viewer in a file

    StopAllAnimation(bool)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    stops all animations

    StopAnimation(uint, bool)

    WARNING: this function is tagged as 'EXPERIMENTAL'
    stops an animation

    StopRecording(int)

    stop recording video

    SuitableGPUAvailable()

    returns true if a suitable device is found.

    TakeScreenshot(string, int)
    TryLockGPUSceneUpdate(int)

    Try to lock the mutex that ensure no update of the gpu scene is done between lock/unlock, returns true if the mutex has been locked, false if it was already locked

    TryLockGPUScenesUpdate(GPUSceneList)

    Try to lock the mutex that ensure no update of multiple gpu scenes is done between lock/unlock, returns true if the mutex has been locked, false if it was already locked

    UnlockGPUSceneUpdate(int)

    Unlock the mutex that ensure no update of the gpu scene is done between lock/unlock

    UnlockGPUScenesUpdate(GPUSceneList)

    Unlock the mutex that ensure no update of multiple gpu scenes is done between lock/unlock

    UnselectPrimitives(int, int, int, int, PrimitiveSelectionType, int)

    Unselect the primitives (polygons, surfaces) contained in the given rectangle

    VisibilityShoot(int, bool, bool, bool, bool)

    Render one frame of the visibility session

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)