docs.unity3d.com
    Show / Hide Table of Contents

    Struct PayloadLockContext

    Holds a value to identify a specific "context" for a Payload buffer lock.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Logging
    Syntax
    [BurstCompile]
    public readonly struct PayloadLockContext : IEquatable<PayloadLockContext>
    Remarks

    This value is returned by LockPayloadBuffer(PayloadHandle) and later passed into UnlockPayloadBuffer(PayloadHandle, PayloadLockContext) to release the lock.

    Properties

    IsValid

    Returns if context value is valid or not.

    Declaration
    public readonly bool IsValid { get; }
    Property Value
    Type Description
    Boolean
    Remarks

    An invalid context means call to LockPayloadBuffer(PayloadHandle) failed.

    Methods

    Equals(PayloadLockContext)

    Compares PayloadLockContext with another one

    Declaration
    public readonly bool Equals(PayloadLockContext other)
    Parameters
    Type Name Description
    PayloadLockContext other

    Another PayloadLockContext to compare with

    Returns
    Type Description
    Boolean

    True if they are equal

    Implements
    IEquatable<T>.Equals(T)
    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