Gorgon
Show / Hide Table of Contents

Class GorgonBufferInfo

Provides the necessary information required to set up a generic unstructured buffer.

Inheritance
object
GorgonBufferInfo
Implements
IGorgonBufferInfo
IGorgonNamedObject
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Gorgon.Graphics.Core
Assembly: Gorgon.Graphics.Core.dll
Syntax
public class GorgonBufferInfo : IGorgonBufferInfo, IGorgonNamedObject

Constructors

| Edit this page View Source

GorgonBufferInfo(IGorgonBufferInfo, string)

Initializes a new instance of the GorgonBufferInfo class.

Declaration
public GorgonBufferInfo(IGorgonBufferInfo info, string newName = null)
Parameters
Type Name Description
IGorgonBufferInfo info

The buffer information to copy.

string newName

[Optional] The new name for the buffer.

Exceptions
Type Condition
ArgumentNullException

Thrown when the info parameter is null.

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; set; }
Property Value
Type Description
bool
| Edit this page View Source

AllowRawView

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

Declaration
public bool AllowRawView { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Binding

Property to return the type of binding for the GPU.

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

IndirectArgs

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

Declaration
public bool IndirectArgs { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Name

Property to return the name of this object.

Declaration
public string Name { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SizeInBytes

Property to return the size of the buffer, in bytes.

Declaration
public int SizeInBytes { get; set; }
Property Value
Type Description
int
| Edit this page View Source

StructureSize

Property to return the size, in bytes, of an individual structure in a structured buffer.

Declaration
public int StructureSize { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Usage

Property to set or return the intended usage for binding to the GPU.

Declaration
public ResourceUsage Usage { get; set; }
Property Value
Type Description
ResourceUsage

Implements

IGorgonBufferInfo
IGorgonNamedObject

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)
GorgonNullExtensions.AsNullable<T>(object)
GorgonNullExtensions.IfNull<T>(object, T)
GorgonNullExtensions.IsNull(object)
  • Edit this page
  • View Source
In this article
Back to top Copyright 2023 - Licensed under the MIT license by Michael Winsor (Tape_Worm).
Send comments on this topic to the author