Class GorgonRawReadWriteView

Provides a read/write (unordered access) view for a GorgonBuffer, exposing the data as raw byte data.

Inheritance
object
GorgonResourceView
GorgonReadWriteView
GorgonBufferReadWriteViewCommon<GorgonBuffer>
GorgonRawReadWriteView
Implements
Inherited Members
Namespace: Gorgon.Graphics.Core
Assembly: Gorgon.Graphics.Core.dll
Syntax
public sealed class GorgonRawReadWriteView : GorgonBufferReadWriteViewCommon<GorgonBuffer>, IDisposable, IGorgonGraphicsObject, IEquatable<GorgonResourceView>, IGorgonBufferInfo, IGorgonNamedObject
Remarks

This type of view allows for unordered access to a GorgonBuffer. The buffer must have been created with the ReadWrite flag in its Binding property, and the AllowRawView flag must have been set to true.

The unordered access allows a shader to read/write any part of a GorgonGraphicsResource by multiple threads without memory contention. This is done through the use of atomic functions.

These types of views are most useful for GorgonComputeShader shaders, but can also be used by a GorgonPixelShader by passing a list of these views in to a draw call.

Properties

| Edit this page View Source

AllowCpuRead

Property to set or return whether to allow the CPU read access to the buffer.

Declaration
public bool AllowCpuRead { get; }
Property Value
Type Description
bool
Remarks

This value indicates whether or not the CPU can directly access the buffer for reading. If this value is false, the buffer still can be read, but will be done through an intermediate staging buffer, which is obviously less performant.

This value is treated as false if the buffer does not have a Binding containing the Shader flag, and does not have a Usage of Default. This means any reads will be done through an intermediate staging buffer, impacting performance.

If the Usage property is set to Staging, then this value is treated as true because staging buffers are CPU only and as such, can be read directly by the CPU regardless of this value.

See Also
| Edit this page View Source

AllowRawView

Property to return whether to allow raw unordered views of the buffer.

Declaration
public bool AllowRawView { get; }
Property Value
Type Description
bool
Remarks

This value is always false for this type of view.

See Also
| Edit this page View Source

Binding

Property to return the type of binding for the GPU.

Declaration
public BufferBinding Binding { get; }
Property Value
Type Description
BufferBinding
See Also
| Edit this page View Source

ElementSize

Property to return the size of an element, in bytes.

Declaration
public override int ElementSize { get; }
Property Value
Type Description
int
Overrides
Remarks

For a raw buffer view, this will always be 4.

See Also
| Edit this page View Source

ElementType

Property to return the type of element stored in the buffer.

Declaration
public RawBufferElementType ElementType { get; }
Property Value
Type Description
RawBufferElementType
See Also
| Edit this page View Source

IndirectArgs

Property to return whether the buffer will contain indirect argument data.

Declaration
public bool IndirectArgs { get; }
Property Value
Type Description
bool
Remarks

This flag only applies to buffers with a Binding of ReadWrite, and/or Shader. If the binding is set to anything else, then this flag is treated as being set to false.

The default value is false.

See Also

Implements

Extension Methods

See Also