Struct GorgonReadWriteViewBinding

A binding for a GorgonReadWriteView.

Implements
Inherited Members
Namespace: Gorgon.Graphics.Core
Assembly: Gorgon.Graphics.Core.dll
Syntax
public readonly struct GorgonReadWriteViewBinding : IGorgonEquatableByRef<GorgonReadWriteViewBinding>, IEquatable<GorgonReadWriteViewBinding>
Remarks

This allows a GorgonReadWriteView to be bound to the GPU pipeline for access by a GorgonPixelShader.

Constructors

| Edit this page View Source

GorgonReadWriteViewBinding(GorgonReadWriteView)

Initializes a new instance of the GorgonReadWriteViewBinding struct.

Declaration
public GorgonReadWriteViewBinding(GorgonReadWriteView readWriteView)
Parameters
Type Name Description
GorgonReadWriteView readWriteView

The read/write view.
See Also
| Edit this page View Source

GorgonReadWriteViewBinding(GorgonStructuredReadWriteView, int)

Initializes a new instance of the GorgonReadWriteViewBinding struct.

Declaration
public GorgonReadWriteViewBinding(GorgonStructuredReadWriteView readWriteView, int initialCount)
Parameters
Type Name Description
GorgonStructuredReadWriteView readWriteView

The read/write view.
int initialCount

The inital count.
See Also

Fields

| Edit this page View Source

Empty

An empty UAV binding.

Declaration
public static readonly GorgonReadWriteViewBinding Empty
Field Value
Type Description
GorgonReadWriteViewBinding
See Also
| Edit this page View Source

InitialCount

An initial count for a GorgonStructuredReadWriteView.

Declaration
public readonly int InitialCount
Field Value
Type Description
int
Remarks

This provides an offset for an append/consume buffer. Setting this value to -1 will indicate that the current offset should be kept. This only applies to an unordered access view that was created with the Append flag set.

See Also
| Edit this page View Source

ReadWriteView

The unordered access view to bind.

Declaration
public readonly GorgonReadWriteView ReadWriteView
Field Value
Type Description
GorgonReadWriteView
See Also

Properties

| Edit this page View Source

ReadWriteViewType

Property to return the type of UAV if the UAV is for a structured buffer.

Declaration
public StructuredBufferReadWriteViewType ReadWriteViewType { get; }
Property Value
Type Description
StructuredBufferReadWriteViewType
See Also

Methods

| Edit this page View Source

Equals(GorgonReadWriteViewBinding)

Function to compare this instance with another.

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

The other instance to use for comparison.
Returns
Type Description
bool

true if equal, false if not.
See Also
| Edit this page View Source

Equals(in GorgonReadWriteViewBinding)

Function to compare this instance with another.

Declaration
public bool Equals(in GorgonReadWriteViewBinding other)
Parameters
Type Name Description
GorgonReadWriteViewBinding other

The other instance to use for comparison.
Returns
Type Description
bool

true if equal, false if not.
See Also
| Edit this page View Source

Equals(in GorgonReadWriteViewBinding, in GorgonReadWriteViewBinding)

Function to determine if two instances are equal.

Declaration
public static bool Equals(in GorgonReadWriteViewBinding left, in GorgonReadWriteViewBinding right)
Parameters
Type Name Description
GorgonReadWriteViewBinding left

The left instance to compare.
GorgonReadWriteViewBinding right

The right instance to compare.
Returns
Type Description
bool

true if equal, false if not.
See Also
| Edit this page View Source

Equals(object)

Indicates whether this instance and a specified object are equal.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current instance.
Returns
Type Description
bool

true if obj and this instance are the same type and represent the same value; otherwise, false.
Overrides
See Also
| Edit this page View Source

GetHashCode()

Returns a hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
Overrides
See Also
| Edit this page View Source

ToString()

Returns a string that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance.
Overrides
See Also

Operators

| Edit this page View Source

operator ==(in GorgonReadWriteViewBinding, in GorgonReadWriteViewBinding)

Operator to determine equality between two instances.

Declaration
public static bool operator ==(in GorgonReadWriteViewBinding left, in GorgonReadWriteViewBinding right)
Parameters
Type Name Description
GorgonReadWriteViewBinding left

The left instance to compare.
GorgonReadWriteViewBinding right

The right instance to compare.
Returns
Type Description
bool

true if equal, false if not.
See Also
| Edit this page View Source

operator !=(in GorgonReadWriteViewBinding, in GorgonReadWriteViewBinding)

Operator to determine inequality between two instances.

Declaration
public static bool operator !=(in GorgonReadWriteViewBinding left, in GorgonReadWriteViewBinding right)
Parameters
Type Name Description
GorgonReadWriteViewBinding left

The left instance to compare.
GorgonReadWriteViewBinding right

The right instance to compare.
Returns
Type Description
bool

true if not equal, false if equal.
See Also

Implements

Extension Methods

See Also