docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ScreenCapture

    A convenience wrapper around CaptureCamera that asynchronously captures a camera's color buffer and writes it to a sequenced file on disk.

    Inheritance
    object
    BaseLogger
    ScreenCapture
    Inherited Members
    BaseLogger._type
    BaseLogger._userPath
    BaseLogger._name
    BaseLogger._extension
    BaseLogger._sequence
    BaseLogger._suffixAction
    BaseLogger._loggerSuffixOption
    BaseLogger.SetOutputPath(string, string, string, string, Func<string>, LoggerSuffixOption)
    BaseLogger.GetPath()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.SimulationPro
    Assembly: Unity.SimulationPro.Capture.dll
    Syntax
    public class ScreenCapture : BaseLogger

    Constructors

    ScreenCapture(string)

    Initializes a new ScreenCapture instance.

    Declaration
    public ScreenCapture(string capturePath = "")
    Parameters
    Type Name Description
    string capturePath

    The capturePath.

    Methods

    ScreenCaptureAsync<T>(Camera, GraphicsFormat, string, ImageFormat)

    Capture Screenshot asynchronously for a given source camera

    Declaration
    public void ScreenCaptureAsync<T>(Camera sourceCamera, GraphicsFormat renderTextureFormat, string path, CaptureImageEncoder.ImageFormat format = ImageFormat.Raw) where T : struct
    Parameters
    Type Name Description
    Camera sourceCamera

    Source camera for which the screen capture is to be performed

    GraphicsFormat renderTextureFormat

    Render Texture format for the screen capture

    string path

    Path where the image is to be saved

    CaptureImageEncoder.ImageFormat format

    Image format in which the file is to be saved. Default is set to RAW

    Type Parameters
    Name Description
    T

    The type parameter.

    In This Article
    Back to top
    Copyright © 2026 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)