Struct BufferDescription
Contains properties that describe the characteristics of a new buffer object.
Implements
Inherited Members
Namespace: Evergine.Common.Graphics
Assembly: Evergine.Common.dll
Syntax
public struct BufferDescription : IEquatable<BufferDescription>
  Constructors
BufferDescription(uint, BufferFlags, ResourceUsage, ResourceCpuAccess, int)
Initializes a new instance of the BufferDescription struct.
Declaration
public BufferDescription(uint sizeInBytes, BufferFlags flags, ResourceUsage usage, ResourceCpuAccess cpuAccess = ResourceCpuAccess.None, int structureByteStride = 0)
  Parameters
| Type | Name | Description | 
|---|---|---|
| uint | sizeInBytes | Size of the buffer in bytes.  | 
      
| BufferFlags | flags | Buffer flags describing the buffer type.  | 
      
| ResourceUsage | usage | Usage for this buffer.  | 
      
| ResourceCpuAccess | cpuAccess | Describe the type of CPU access allowed for.  | 
      
| int | structureByteStride | The structure byte stride.  | 
      
Fields
CpuAccess
Specifies the types of CPU access allowed for this buffer.
Declaration
public ResourceCpuAccess CpuAccess
  Field Value
| Type | Description | 
|---|---|
| ResourceCpuAccess | 
Flags
Buffer flags describing buffer type.
Declaration
public BufferFlags Flags
  Field Value
| Type | Description | 
|---|---|
| BufferFlags | 
SizeInBytes
Retrieves or sets the size of the new buffer.
Declaration
public uint SizeInBytes
  Field Value
| Type | Description | 
|---|---|
| uint | 
StructureByteStride
The structure byte stride.
Declaration
public int StructureByteStride
  Field Value
| Type | Description | 
|---|---|
| int | 
Usage
Usage of this buffer.
Declaration
public ResourceUsage Usage
  Field Value
| Type | Description | 
|---|---|
| ResourceUsage | 
Methods
Equals(BufferDescription)
Determines whether the specified parameter is equal to this instance.
Declaration
public bool Equals(BufferDescription other)
  Parameters
| Type | Name | Description | 
|---|---|---|
| BufferDescription | other | Other used to compare.  | 
      
Returns
| Type | Description | 
|---|---|
| bool | 
  | 
      
Equals(object)
Determines whether the specified object is equal to this instance.
Declaration
public override bool Equals(object obj)
  Parameters
| Type | Name | Description | 
|---|---|---|
| object | obj | The object to compare with this instance.  | 
      
Returns
| Type | Description | 
|---|---|
| bool | 
  | 
      
Overrides
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
Operators
operator ==(BufferDescription, BufferDescription)
Implements the operator ==.
Declaration
public static bool operator ==(BufferDescription value1, BufferDescription value2)
  Parameters
| Type | Name | Description | 
|---|---|---|
| BufferDescription | value1 | The value1.  | 
      
| BufferDescription | value2 | The value2.  | 
      
Returns
| Type | Description | 
|---|---|
| bool | The result of the operator.  | 
      
operator !=(BufferDescription, BufferDescription)
Implements the operator ==.
Declaration
public static bool operator !=(BufferDescription value1, BufferDescription value2)
  Parameters
| Type | Name | Description | 
|---|---|---|
| BufferDescription | value1 | The value1.  | 
      
| BufferDescription | value2 | The value2.  | 
      
Returns
| Type | Description | 
|---|---|
| bool | The result of the operator.  |