docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct PayloadLockContext

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

    Implements
    IEquatable<PayloadLockContext>
    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Unity.Logging
    Assembly: Unity.Logging.dll
    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 bool IsValid { get; }
    Property Value
    Type Description
    bool
    Remarks

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

    Methods

    Equals(PayloadLockContext)

    Compares PayloadLockContext with another one

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

    Another PayloadLockContext to compare with

    Returns
    Type Description
    bool

    True if they are equal

    Implements

    IEquatable<T>
    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)