Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    UpdatableField Class

    Namespace: Stride.Updater
    Assembly: Stride.Engine.dll

    Defines how to set and get values from a field for the UpdateEngine.

    System.Object → UpdatableMember → UpdatableField
    Derived from UpdatableField: UpdatableField<T>

    public abstract class UpdatableField : UpdatableMember
    Name Description
    Fields
    Offset

    Offset of this field in its containing object.

    Size

    Size of this field.

    Methods
    GetObject(IntPtr)

    Gets a reference object from a field.

    GetSetOperationType()

    Internally used to know type of set operation to use.

    SetBlittable(IntPtr, IntPtr)

    Sets a blittable field (from its pointer).

    SetObject(IntPtr, Object)

    Sets a reference object from a field.

    SetStruct(IntPtr, Object)

    Sets a non-blittable struct field (given in boxed form).

    | Improve this Doc View Source

    Fields


    Offset

    Offset of this field in its containing object.

    public int Offset
    Field Value
    Type Description
    System.Int32

    Size

    Size of this field.

    public int Size
    Field Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    Methods


    GetObject(IntPtr)

    Gets a reference object from a field.

    public object GetObject(IntPtr obj)
    Parameters
    Type Name Description
    System.IntPtr obj

    The object encoded as a native pointer (UpdateEngine will make sure it is pinned).

    Returns
    Type Description
    System.Object

    The object value from the field.


    GetSetOperationType()

    Internally used to know type of set operation to use.

    public UpdateOperationType GetSetOperationType()
    Returns
    Type Description
    UpdateOperationType

    SetBlittable(IntPtr, IntPtr)

    Sets a blittable field (from its pointer).

    public void SetBlittable(IntPtr obj, IntPtr data)
    Parameters
    Type Name Description
    System.IntPtr obj

    The container object.

    System.IntPtr data

    The struct data.


    SetObject(IntPtr, Object)

    Sets a reference object from a field.

    public void SetObject(IntPtr obj, object data)
    Parameters
    Type Name Description
    System.IntPtr obj

    The object encoded as a native pointer (UpdateEngine will make sure it is pinned).

    System.Object data

    The object value to set.


    SetStruct(IntPtr, Object)

    Sets a non-blittable struct field (given in boxed form).

    public abstract void SetStruct(IntPtr obj, object data)
    Parameters
    Type Name Description
    System.IntPtr obj

    The container object.

    System.Object data

    The new value to unbox and set


    Inherited Members

    UpdatableMember.MemberType
    UpdatableMember.CreateEnterChecker()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation