Struct DispatchParameters

Namespace

Bonsai.Shaders

Assembly

Bonsai.Shaders.dll

Represents parameters used when launching compute shader work groups.

[TypeConverter(typeof(NumericRecordConverter))]
public struct DispatchParameters : IEquatable<DispatchParameters>

Implements

IEquatable<DispatchParameters>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Constructors

DispatchParameters(int, int, int)

Initializes a new instance of the DispatchParameters structure using the specified number of compute work groups.

public DispatchParameters(int numGroupsX, int numGroupsY, int numGroupsZ)

Parameters

numGroupsX int

The number of work groups to be launched in the X dimension.

numGroupsY int

The number of work groups to be launched in the Y dimension.

numGroupsZ int

The number of work groups to be launched in the Z dimension.

Fields

NumGroupsX

The number of work groups to be launched in the X dimension.

public int NumGroupsX

Field Value

int

NumGroupsY

The number of work groups to be launched in the Y dimension.

public int NumGroupsY

Field Value

int

NumGroupsZ

The number of work groups to be launched in the Z dimension.

public int NumGroupsZ

Field Value

int

Methods

Equals(DispatchParameters)

Returns a value indicating whether this instance is equal to the specified DispatchParameters structure.

public bool Equals(DispatchParameters other)

Parameters

other DispatchParameters

The DispatchParameters object to compare with this instance.

Returns

bool

true if other represents the same parameter values as this instance; otherwise, false.

Equals(object)

Returns a value indicating whether the specified object is a DispatchParameters structure with the same parameter values as this instance.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with this instance.

Returns

bool

true if obj is a DispatchParameters structure and has the same parameter values as this structure; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Creates a string representation of this DispatchParameters structure.

public override string ToString()

Returns

string

A string containing all the parameter values of this DispatchParameters structure.

Operators

operator ==(DispatchParameters, DispatchParameters)

Indicates whether two DispatchParameters structures are equal.

public static bool operator ==(DispatchParameters left, DispatchParameters right)

Parameters

left DispatchParameters

The DispatchParameters structure on the left-hand side of the equality operator.

right DispatchParameters

The DispatchParameters structure on the right-hand side of the equality operator.

Returns

bool

true if left and right have equal parameter values; otherwise, false.

operator !=(DispatchParameters, DispatchParameters)

Indicates whether two DispatchParameters structures are different.

public static bool operator !=(DispatchParameters left, DispatchParameters right)

Parameters

left DispatchParameters

The DispatchParameters structure on the left-hand side of the inequality operator.

right DispatchParameters

The DispatchParameters structure on the right-hand side of the inequality operator.

Returns

bool

true if left and right differ in any of their parameter values; false if left and right are equal.