Struct ComputePipelineDescription
Contains properties that describe the characteristics of a new pipeline state object.
Implements
Inherited Members
Namespace: Evergine.Common.Graphics
Assembly: Evergine.Common.dll
Syntax
public struct ComputePipelineDescription : IEquatable<ComputePipelineDescription>
  Constructors
ComputePipelineDescription(ResourceLayout[], ComputeShaderStateDescription, uint, uint, uint)
Initializes a new instance of the ComputePipelineDescription struct.
Declaration
public ComputePipelineDescription(ResourceLayout[] resourceLayouts, ComputeShaderStateDescription shaderDescription, uint threadGroupSizeX = 1, uint threadGroupSizeY = 1, uint threadGroupSizeZ = 1)
  Parameters
| Type | Name | Description | 
|---|---|---|
| ResourceLayout[] | resourceLayouts | The resources layout description.  | 
      
| ComputeShaderStateDescription | shaderDescription | The compute shader.  | 
      
| uint | threadGroupSizeX | The X dimension of the thread group size.  | 
      
| uint | threadGroupSizeY | The Y dimension of the thread group size.  | 
      
| uint | threadGroupSizeZ | The Z dimension of the thread group size.  | 
      
Fields
ResourceLayouts
Describes the resources layout input.
Declaration
public ResourceLayout[] ResourceLayouts
  Field Value
| Type | Description | 
|---|---|
| ResourceLayout[] | 
ThreadGroupSizeX
The X dimension of the thread group size.
Declaration
public uint ThreadGroupSizeX
  Field Value
| Type | Description | 
|---|---|
| uint | 
ThreadGroupSizeY
The Y dimension of the thread group size.
Declaration
public uint ThreadGroupSizeY
  Field Value
| Type | Description | 
|---|---|
| uint | 
ThreadGroupSizeZ
The Z dimension of the thread group size.
Declaration
public uint ThreadGroupSizeZ
  Field Value
| Type | Description | 
|---|---|
| uint | 
shaderDescription
Gets or sets the compute shader program.
Declaration
public ComputeShaderStateDescription shaderDescription
  Field Value
| Type | Description | 
|---|---|
| ComputeShaderStateDescription | 
Methods
Equals(ComputePipelineDescription)
Returns a hash code for this instance.
Declaration
public bool Equals(ComputePipelineDescription other)
  Parameters
| Type | Name | Description | 
|---|---|---|
| ComputePipelineDescription | other | Other used to compare.  | 
      
Returns
| Type | Description | 
|---|---|
| bool | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.  | 
      
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 ==(ComputePipelineDescription, ComputePipelineDescription)
Implements the operator ==.
Declaration
public static bool operator ==(ComputePipelineDescription value1, ComputePipelineDescription value2)
  Parameters
| Type | Name | Description | 
|---|---|---|
| ComputePipelineDescription | value1 | The value1.  | 
      
| ComputePipelineDescription | value2 | The value2.  | 
      
Returns
| Type | Description | 
|---|---|
| bool | The result of the operator.  | 
      
operator !=(ComputePipelineDescription, ComputePipelineDescription)
Implements the operator ==.
Declaration
public static bool operator !=(ComputePipelineDescription value1, ComputePipelineDescription value2)
  Parameters
| Type | Name | Description | 
|---|---|---|
| ComputePipelineDescription | value1 | The value1.  | 
      
| ComputePipelineDescription | value2 | The value2.  | 
      
Returns
| Type | Description | 
|---|---|
| bool | The result of the operator.  |