ComputeShader 与 ComputeBuffer 资料

ComputeShader

Description

Compute Shader asset.

Compute shaders are programs that run on the GPU outside of the normal rendering pipeline. They correspond to compute shader assets in the project (.compute files).

Compute shader support can be queried runtime using SystemInfo.supportsComputeShaders. See Compute Shaders overview for more info about platforms supporting compute shaders.

Properties

enabledKeywords	An array containing the local shader keywords that are currently enabled for this compute shader.
keywordSpace	The local keyword space of this compute shader.
shaderKeywords	An array containing names of the local shader keywords that are currently enabled for this compute shader.

Public Methods

DisableKeyword	Disables a local shader keyword for this compute shader.
Dispatch	Execute a compute shader.
DispatchIndirect	Execute a compute shader.
EnableKeyword	Enables a local shader keyword for this compute shader.
FindKernel	Find ComputeShader kernel index.
GetKernelThreadGroupSizes	Get kernel thread group sizes.
HasKernel	Checks whether a shader contains a given kernel.
IsKeywordEnabled	Checks whether a local shader keyword is enabled for this compute shader.
IsSupported	Allows you to check whether the current end user device supports the features required to run the specified compute shader kernel.
SetBool	Set a bool parameter.
SetBuffer	Sets an input or output compute buffer.
SetConstantBuffer	Sets a ComputeBuffer or a GraphicsBuffer as a named constant buffer for the ComputeShader.
SetFloat	Set a float parameter.
SetFloats	Set multiple consecutive float parameters at once.
SetInt	Set an integer parameter.
SetInts	Set multiple consecutive integer parameters at once.
SetKeyword	Sets the state of a local shader keyword for this compute shader.
SetMatrix	Set a Matrix parameter.
SetMatrixArray	Set a Matrix array parameter.
SetTexture	Set a texture parameter.
SetTextureFromGlobal	Set a texture parameter from a global texture property.
SetVector	Set a vector parameter.
SetVectorArray	Set a vector array parameter.

Inherited Members

Properties

hideFlags	Should the object be hidden, saved with the Scene or modifiable by the user?
name	The name of the object.

Public Methods

GetInstanceID	Gets the instance ID of the object.
ToString	Returns the name of the object.

Static Methods

Destroy	Removes a GameObject, component or asset.
DestroyImmediate	Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad	Do not destroy the target Object when loading a new Scene.
FindObjectOfType	Returns the first active loaded object of Type type.
FindObjectsOfType	Gets a list of all loaded objects of Type type.
Instantiate	Clones the object original and returns the clone.

Operators

bool	Does the object exist?
operator !=	Compares if two objects refer to a different object.
operator ==	Compares two object references to see if they refer to the same object.

/

ComputeBuffer

Description

GPU data buffer, mostly for use with compute shaders.

ComputeShader programs often need arbitrary data to be read & written into memory buffers. ComputeBuffer class is exactly for that - you can create & fill them from script code, and use them in compute shaders or regular shaders.

Compute buffers are always supported in compute shaders. Compute shader support can be queried runtime using SystemInfo.supportsComputeShaders. See the Compute Shaders Manual page for more information about platforms supporting compute shaders. In regular graphics shaders the compute buffer support requires minimum shader model 4.5.

For a ComputeBuffer that uses a counter, Metal and Vulkan platforms don't have native counters and use separate small buffers that act as counters internally. These small buffers are bound separately from the ComputeBuffer and count towards the limit of possible buffers bound (31 for Metal, based on the device for Vulkan).

On the shader side, ComputeBuffers with default ComputeBufferType map to StructuredBuffer<T> and RWStructuredBuffer<T> in HLSL.

See Also: ComputeShader class, Shader.SetGlobalBuffer, Material.SetBuffer, Compute Shaders overview.

Properties

count	Number of elements in the buffer (Read Only).
name	The debug label for the compute buffer (setter only).
stride	Size of one element in the buffer (Read Only).

Constructors

ComputeBuffer

Create a Compute Buffer.

Public Methods

BeginWrite	Begins a write operation to the buffer
EndWrite	Ends a write operation to the buffer
GetData	Read data values from the buffer into an array. The array can only use blittable types.
GetNativeBufferPtr	Retrieve a native (underlying graphics API) pointer to the buffer.
IsValid	Returns true if this compute buffer is valid and false otherwise.
Release	Release a Compute Buffer.
SetCounterValue	Sets counter value of append/consume buffer.
SetData	Set the buffer with values from an array.

Static Methods

CopyCount

Copy counter value of append/consume buffer into another buffer.

//

//