Table of Contents

Class BufferResource

Namespace
ReFuel.Resources
Assembly
ReFuel.dll
[NoDefaultConstructor(true)]
public class BufferResource : ResourceEntity, IEnumerable<EcsNode>, IEnumerable, IResourceInfo, IArc, IDisposable, IInitializer, IInitializer<BufferCreateInfo>, IInitializerBase
Inheritance
BufferResource
Implements
Inherited Members
Extension Methods

Properties

Class

The class of this resource.

public override ResourceClass Class { get; }

Property Value

ResourceClass

ClientBacked

public bool ClientBacked { get; }

Property Value

bool

ClientBuffer

public IBufferProvider? ClientBuffer { get; }

Property Value

IBufferProvider

HardwareBacked

public bool HardwareBacked { get; }

Property Value

bool

HardwareBuffer

public IBufferProvider? HardwareBuffer { get; }

Property Value

IBufferProvider

Mode

public BufferMode Mode { get; }

Property Value

BufferMode

Status

public BufferStatusBits Status { get; }

Property Value

BufferStatusBits

Methods

AcquireClient(bool, TimeSpan?)

public BufferLock AcquireClient(bool isReadonly = true, TimeSpan? timeout = null)

Parameters

isReadonly bool
timeout TimeSpan?

Returns

BufferLock

AcquireHardware(bool, TimeSpan?)

public BufferLock AcquireHardware(bool isReadonly = true, TimeSpan? timeout = null)

Parameters

isReadonly bool
timeout TimeSpan?

Returns

BufferLock

Dispose(bool)

Internal function to handle dispose behavior.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if disposing.

Initialize(BufferCreateInfo)

public void Initialize(BufferCreateInfo create)

Parameters

create BufferCreateInfo

Receive()

Copy hardware data to client.

public void Receive()

Transmit()

Copy client data to hardware.

public void Transmit()

TryAcquireClient(out BufferLock, bool, TimeSpan?)

public bool TryAcquireClient(out BufferLock @lock, bool isReadonly = true, TimeSpan? timeout = null)

Parameters

lock BufferLock
isReadonly bool
timeout TimeSpan?

Returns

bool

TryAcquireHardware(out BufferLock, bool, TimeSpan?)

public bool TryAcquireHardware(out BufferLock @lock, bool isReadonly = true, TimeSpan? timeout = null)

Parameters

lock BufferLock
isReadonly bool
timeout TimeSpan?

Returns

bool