Class AlembicRecorder | Alembic | 2.0.1-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class AlembicRecorder

    Class that implements the recording of Unity Scene elements in the Alembic format.

    Inheritance
    Object
    AlembicRecorder
    Namespace: UnityEngine.Formats.Alembic.Util
    Syntax
    [Serializable]
    public sealed class AlembicRecorder : IDisposable

    Properties

    FrameCount

    Get or set the frame number the capture stops at.

    Declaration
    public int FrameCount { get; set; }
    Property Value
    Type Description
    Int32

    Recording

    Get the recording status.

    Declaration
    public bool Recording { get; }
    Property Value
    Type Description
    Boolean

    True if a recording session is active.

    Settings

    Get or set the Recorder settings.

    Declaration
    public AlembicRecorderSettings Settings { get; set; }
    Property Value
    Type Description
    AlembicRecorderSettings

    TargetBranch

    Get or set the recording target branch. Ignored if Scope is set to EntireScene.

    Declaration
    public GameObject TargetBranch { get; set; }
    Property Value
    Type Description
    GameObject

    Methods

    BeginRecording()

    Starts a recording session.

    Declaration
    public bool BeginRecording()
    Returns
    Type Description
    Boolean

    True if succeeded, false otherwise.

    Dispose()

    Deallocate the native resources.

    Declaration
    public void Dispose()

    EndRecording()

    Ends the recording session.

    Declaration
    public void EndRecording()

    ProcessRecording()

    Writes the current frame to the Alembic archive. Recording should have been previously started.

    Declaration
    public void ProcessRecording()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023