Interface IBaseCommandBuffer

This interface declares functions shared by several command buffer types.

Namespace: UnityEngine.Experimental.Rendering

Assembly: Unity.RenderPipelines.Core.Runtime.dll

Syntax

public interface IBaseCommandBuffer

Methods

BeginSample(string)

Wraps BeginSample on a CommandBuffer.

Declaration

void BeginSample(string name)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation

BeginSample(ProfilerMarker)

Wraps BeginSample on a CommandBuffer.

Declaration

void BeginSample(ProfilerMarker marker)

Parameters

Type	Name	Description
ProfilerMarker	marker	See CommandBuffer documentation

BeginSample(CustomSampler)

Wraps BeginSample on a CommandBuffer.

Declaration

void BeginSample(CustomSampler sampler)

Parameters

Type	Name	Description
CustomSampler	sampler	See CommandBuffer documentation

DisableKeyword(ComputeShader, ref LocalKeyword)

Wraps DisableKeyword on a CommandBuffer.

Declaration

void DisableKeyword(ComputeShader computeShader, ref LocalKeyword keyword)

Parameters

Type	Name	Description
ComputeShader	computeShader	See CommandBuffer documentation
LocalKeyword	keyword	See CommandBuffer documentation

DisableKeyword(Material, ref LocalKeyword)

Wraps DisableKeyword on a CommandBuffer.

Declaration

void DisableKeyword(Material material, ref LocalKeyword keyword)

Parameters

Type	Name	Description
Material	material	See CommandBuffer documentation
LocalKeyword	keyword	See CommandBuffer documentation

DisableKeyword(ref GlobalKeyword)

Wraps DisableKeyword on a CommandBuffer.

Declaration

void DisableKeyword(ref GlobalKeyword keyword)

Parameters

Type	Name	Description
GlobalKeyword	keyword	See CommandBuffer documentation

DisableScissorRect()

Wraps DisableScissorRect on a CommandBuffer.

Declaration

void DisableScissorRect()

DisableShaderKeyword(string)

Wraps DisableShaderKeyword on a CommandBuffer.

Declaration

void DisableShaderKeyword(string keyword)

Parameters

Type	Name	Description
string	keyword	See CommandBuffer documentation

EnableKeyword(ComputeShader, ref LocalKeyword)

Wraps EnableKeyword on a CommandBuffer.

Declaration

void EnableKeyword(ComputeShader computeShader, ref LocalKeyword keyword)

Parameters

Type	Name	Description
ComputeShader	computeShader	See CommandBuffer documentation
LocalKeyword	keyword	See CommandBuffer documentation

EnableKeyword(Material, ref LocalKeyword)

Wraps EnableKeyword on a CommandBuffer.

Declaration

void EnableKeyword(Material material, ref LocalKeyword keyword)

Parameters

Type	Name	Description
Material	material	See CommandBuffer documentation
LocalKeyword	keyword	See CommandBuffer documentation

EnableKeyword(ref GlobalKeyword)

Wraps EnableKeyword on a CommandBuffer.

Declaration

void EnableKeyword(ref GlobalKeyword keyword)

Parameters

Type	Name	Description
GlobalKeyword	keyword	See CommandBuffer documentation

EnableScissorRect(Rect)

Wraps EnableScissorRect on a CommandBuffer.

Declaration

void EnableScissorRect(Rect scissor)

Parameters

Type	Name	Description
Rect	scissor	See CommandBuffer documentation

EnableShaderKeyword(string)

Wraps EnableShaderKeyword on a CommandBuffer.

Declaration

void EnableShaderKeyword(string keyword)

Parameters

Type	Name	Description
string	keyword	See CommandBuffer documentation

EndSample(string)

Wraps EndSample on a CommandBuffer.

Declaration

void EndSample(string name)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation

EndSample(ProfilerMarker)

Wraps EndSample on a CommandBuffer.

Declaration

void EndSample(ProfilerMarker marker)

Parameters

Type	Name	Description
ProfilerMarker	marker	See CommandBuffer documentation

EndSample(CustomSampler)

Wraps EndSample on a CommandBuffer.

Declaration

void EndSample(CustomSampler sampler)

Parameters

Type	Name	Description
CustomSampler	sampler	See CommandBuffer documentation

IncrementUpdateCount(RenderTargetIdentifier)

Wraps IncrementUpdateCount on a CommandBuffer.

Declaration

void IncrementUpdateCount(RenderTargetIdentifier dest)

Parameters

Type	Name	Description
RenderTargetIdentifier	dest	See CommandBuffer documentation

InvokeOnRenderObjectCallbacks()

Wraps InvokeOnRenderObjectCallbacks on a CommandBuffer.

Declaration

void InvokeOnRenderObjectCallbacks()

IssuePluginCustomBlit(IntPtr, uint, RenderTargetIdentifier, RenderTargetIdentifier, uint, uint)

Wraps IssuePluginCustomBlit on a CommandBuffer.

Declaration

void IssuePluginCustomBlit(IntPtr callback, uint command, RenderTargetIdentifier source, RenderTargetIdentifier dest, uint commandParam, uint commandFlags)

Parameters

Type	Name	Description
IntPtr	callback	See CommandBuffer documentation
uint	command	See CommandBuffer documentation
RenderTargetIdentifier	source	See CommandBuffer documentation
RenderTargetIdentifier	dest	See CommandBuffer documentation
uint	commandParam	See CommandBuffer documentation
uint	commandFlags	See CommandBuffer documentation

IssuePluginCustomTextureUpdateV2(IntPtr, Texture, uint)

Wraps IssuePluginCustomTextureUpdateV2 on a CommandBuffer.

Declaration

void IssuePluginCustomTextureUpdateV2(IntPtr callback, Texture targetTexture, uint userData)

Parameters

Type	Name	Description
IntPtr	callback	See CommandBuffer documentation
Texture	targetTexture	See CommandBuffer documentation
uint	userData	See CommandBuffer documentation

IssuePluginEvent(IntPtr, int)

Wraps IssuePluginEvent on a CommandBuffer.

Declaration

void IssuePluginEvent(IntPtr callback, int eventID)

Parameters

Type	Name	Description
IntPtr	callback	See CommandBuffer documentation
int	eventID	See CommandBuffer documentation

IssuePluginEventAndData(IntPtr, int, IntPtr)

Wraps IssuePluginEventAndData on a CommandBuffer.

Declaration

void IssuePluginEventAndData(IntPtr callback, int eventID, IntPtr data)

Parameters

Type	Name	Description
IntPtr	callback	See CommandBuffer documentation
int	eventID	See CommandBuffer documentation
IntPtr	data	See CommandBuffer documentation

MarkLateLatchMatrixShaderPropertyID(CameraLateLatchMatrixType, int)

Wraps MarkLateLatchMatrixShaderPropertyID on a CommandBuffer.

Declaration

void MarkLateLatchMatrixShaderPropertyID(CameraLateLatchMatrixType matrixPropertyType, int shaderPropertyID)

Parameters

Type	Name	Description
CameraLateLatchMatrixType	matrixPropertyType	See CommandBuffer documentation
int	shaderPropertyID	See CommandBuffer documentation

SetGlobalBuffer(int, ComputeBuffer)

Wraps SetGlobalBuffer on a CommandBuffer.

Declaration

void SetGlobalBuffer(int nameID, ComputeBuffer value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
ComputeBuffer	value	See CommandBuffer documentation

SetGlobalBuffer(int, GraphicsBuffer)

Wraps SetGlobalBuffer on a CommandBuffer.

Declaration

void SetGlobalBuffer(int nameID, GraphicsBuffer value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
GraphicsBuffer	value	See CommandBuffer documentation

SetGlobalBuffer(string, ComputeBuffer)

Wraps SetGlobalBuffer on a CommandBuffer.

Declaration

void SetGlobalBuffer(string name, ComputeBuffer value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
ComputeBuffer	value	See CommandBuffer documentation

SetGlobalBuffer(string, GraphicsBuffer)

Wraps SetGlobalBuffer on a CommandBuffer.

Declaration

void SetGlobalBuffer(string name, GraphicsBuffer value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
GraphicsBuffer	value	See CommandBuffer documentation

SetGlobalColor(int, Color)

Wraps SetGlobalColor on a CommandBuffer.

Declaration

void SetGlobalColor(int nameID, Color value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
Color	value	See CommandBuffer documentation

SetGlobalColor(string, Color)

Wraps SetGlobalColor on a CommandBuffer.

Declaration

void SetGlobalColor(string name, Color value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
Color	value	See CommandBuffer documentation

SetGlobalConstantBuffer(ComputeBuffer, int, int, int)

Wraps SetGlobalConstantBuffer on a CommandBuffer.

Declaration

void SetGlobalConstantBuffer(ComputeBuffer buffer, int nameID, int offset, int size)

Parameters

Type	Name	Description
ComputeBuffer	buffer	See CommandBuffer documentation
int	nameID	See CommandBuffer documentation
int	offset	See CommandBuffer documentation
int	size	See CommandBuffer documentation

SetGlobalConstantBuffer(ComputeBuffer, string, int, int)

Wraps SetGlobalConstantBuffer on a CommandBuffer.

Declaration

void SetGlobalConstantBuffer(ComputeBuffer buffer, string name, int offset, int size)

Parameters

Type	Name	Description
ComputeBuffer	buffer	See CommandBuffer documentation
string	name	See CommandBuffer documentation
int	offset	See CommandBuffer documentation
int	size	See CommandBuffer documentation

SetGlobalConstantBuffer(GraphicsBuffer, int, int, int)

Wraps SetGlobalConstantBuffer on a CommandBuffer.

Declaration

void SetGlobalConstantBuffer(GraphicsBuffer buffer, int nameID, int offset, int size)

Parameters

Type	Name	Description
GraphicsBuffer	buffer	See CommandBuffer documentation
int	nameID	See CommandBuffer documentation
int	offset	See CommandBuffer documentation
int	size	See CommandBuffer documentation

SetGlobalConstantBuffer(GraphicsBuffer, string, int, int)

Wraps SetGlobalConstantBuffer on a CommandBuffer.

Declaration

void SetGlobalConstantBuffer(GraphicsBuffer buffer, string name, int offset, int size)

Parameters

Type	Name	Description
GraphicsBuffer	buffer	See CommandBuffer documentation
string	name	See CommandBuffer documentation
int	offset	See CommandBuffer documentation
int	size	See CommandBuffer documentation

SetGlobalDepthBias(float, float)

Wraps SetGlobalDepthBias on a CommandBuffer.

Declaration

void SetGlobalDepthBias(float bias, float slopeBias)

Parameters

Type	Name	Description
float	bias	See CommandBuffer documentation
float	slopeBias	See CommandBuffer documentation

SetGlobalFloat(int, float)

Wraps SetGlobalFloat on a CommandBuffer.

Declaration

void SetGlobalFloat(int nameID, float value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
float	value	See CommandBuffer documentation

SetGlobalFloat(string, float)

Wraps SetGlobalFloat on a CommandBuffer.

Declaration

void SetGlobalFloat(string name, float value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
float	value	See CommandBuffer documentation

SetGlobalFloatArray(int, List<float>)

Wraps SetGlobalFloatArray on a CommandBuffer.

Declaration

void SetGlobalFloatArray(int nameID, List<float> values)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
List<float>	values	See CommandBuffer documentation

SetGlobalFloatArray(int, float[])

Wraps SetGlobalFloatArray on a CommandBuffer.

Declaration

void SetGlobalFloatArray(int nameID, float[] values)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
float[]	values	See CommandBuffer documentation

SetGlobalFloatArray(string, List<float>)

Wraps SetGlobalFloatArray on a CommandBuffer.

Declaration

void SetGlobalFloatArray(string propertyName, List<float> values)

Parameters

Type	Name	Description
string	propertyName	See CommandBuffer documentation
List<float>	values	See CommandBuffer documentation

SetGlobalFloatArray(string, float[])

Wraps SetGlobalFloatArray on a CommandBuffer.

Declaration

void SetGlobalFloatArray(string propertyName, float[] values)

Parameters

Type	Name	Description
string	propertyName	See CommandBuffer documentation
float[]	values	See CommandBuffer documentation

SetGlobalInt(int, int)

Wraps SetGlobalInt on a CommandBuffer.

Declaration

void SetGlobalInt(int nameID, int value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
int	value	See CommandBuffer documentation

SetGlobalInt(string, int)

Wraps SetGlobalInt on a CommandBuffer.

Declaration

void SetGlobalInt(string name, int value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
int	value	See CommandBuffer documentation

SetGlobalInteger(int, int)

Wraps SetGlobalInteger on a CommandBuffer.

Declaration

void SetGlobalInteger(int nameID, int value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
int	value	See CommandBuffer documentation

SetGlobalInteger(string, int)

Wraps SetGlobalInteger on a CommandBuffer.

Declaration

void SetGlobalInteger(string name, int value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
int	value	See CommandBuffer documentation

SetGlobalMatrix(int, Matrix4x4)

Wraps SetGlobalMatrix on a CommandBuffer.

Declaration

void SetGlobalMatrix(int nameID, Matrix4x4 value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
Matrix4x4	value	See CommandBuffer documentation

SetGlobalMatrix(string, Matrix4x4)

Wraps SetGlobalMatrix on a CommandBuffer.

Declaration

void SetGlobalMatrix(string name, Matrix4x4 value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
Matrix4x4	value	See CommandBuffer documentation

SetGlobalMatrixArray(int, List<Matrix4x4>)

Wraps SetGlobalMatrixArray on a CommandBuffer.

Declaration

void SetGlobalMatrixArray(int nameID, List<Matrix4x4> values)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
List<Matrix4x4>	values	See CommandBuffer documentation

SetGlobalMatrixArray(int, Matrix4x4[])

Wraps SetGlobalMatrixArray on a CommandBuffer.

Declaration

void SetGlobalMatrixArray(int nameID, Matrix4x4[] values)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
Matrix4x4[]	values	See CommandBuffer documentation

SetGlobalMatrixArray(string, List<Matrix4x4>)

Wraps SetGlobalMatrixArray on a CommandBuffer.

Declaration

void SetGlobalMatrixArray(string propertyName, List<Matrix4x4> values)

Parameters

Type	Name	Description
string	propertyName	See CommandBuffer documentation
List<Matrix4x4>	values	See CommandBuffer documentation

SetGlobalMatrixArray(string, Matrix4x4[])

Wraps SetGlobalMatrixArray on a CommandBuffer.

Declaration

void SetGlobalMatrixArray(string propertyName, Matrix4x4[] values)

Parameters

Type	Name	Description
string	propertyName	See CommandBuffer documentation
Matrix4x4[]	values	See CommandBuffer documentation

SetGlobalTexture(int, TextureHandle)

Wraps SetGlobalTexture on a CommandBuffer.

Declaration

void SetGlobalTexture(int nameID, TextureHandle value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
TextureHandle	value	See CommandBuffer documentation

SetGlobalTexture(int, TextureHandle, RenderTextureSubElement)

Wraps SetGlobalTexture on a CommandBuffer.

Declaration

void SetGlobalTexture(int nameID, TextureHandle value, RenderTextureSubElement element)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
TextureHandle	value	See CommandBuffer documentation
RenderTextureSubElement	element	See CommandBuffer documentation

SetGlobalTexture(string, TextureHandle)

Wraps SetGlobalTexture on a CommandBuffer.

Declaration

void SetGlobalTexture(string name, TextureHandle value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
TextureHandle	value	See CommandBuffer documentation

SetGlobalTexture(string, TextureHandle, RenderTextureSubElement)

Wraps SetGlobalTexture on a CommandBuffer.

Declaration

void SetGlobalTexture(string name, TextureHandle value, RenderTextureSubElement element)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
TextureHandle	value	See CommandBuffer documentation
RenderTextureSubElement	element	See CommandBuffer documentation

SetGlobalVector(int, Vector4)

Wraps SetGlobalVector on a CommandBuffer.

Declaration

void SetGlobalVector(int nameID, Vector4 value)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
Vector4	value	See CommandBuffer documentation

SetGlobalVector(string, Vector4)

Wraps SetGlobalVector on a CommandBuffer.

Declaration

void SetGlobalVector(string name, Vector4 value)

Parameters

Type	Name	Description
string	name	See CommandBuffer documentation
Vector4	value	See CommandBuffer documentation

SetGlobalVectorArray(int, List<Vector4>)

Wraps SetGlobalVectorArray on a CommandBuffer.

Declaration

void SetGlobalVectorArray(int nameID, List<Vector4> values)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
List<Vector4>	values	See CommandBuffer documentation

SetGlobalVectorArray(int, Vector4[])

Wraps SetGlobalVectorArray on a CommandBuffer.

Declaration

void SetGlobalVectorArray(int nameID, Vector4[] values)

Parameters

Type	Name	Description
int	nameID	See CommandBuffer documentation
Vector4[]	values	See CommandBuffer documentation

SetGlobalVectorArray(string, List<Vector4>)

Wraps SetGlobalVectorArray on a CommandBuffer.

Declaration

void SetGlobalVectorArray(string propertyName, List<Vector4> values)

Parameters

Type	Name	Description
string	propertyName	See CommandBuffer documentation
List<Vector4>	values	See CommandBuffer documentation

SetGlobalVectorArray(string, Vector4[])

Wraps SetGlobalVectorArray on a CommandBuffer.

Declaration

void SetGlobalVectorArray(string propertyName, Vector4[] values)

Parameters

Type	Name	Description
string	propertyName	See CommandBuffer documentation
Vector4[]	values	See CommandBuffer documentation

SetInvertCulling(bool)

Wraps SetInvertCulling on a CommandBuffer.

Declaration

void SetInvertCulling(bool invertCulling)

Parameters

Type	Name	Description
bool	invertCulling	See CommandBuffer documentation

SetKeyword(ComputeShader, ref LocalKeyword, bool)

Wraps SetKeyword on a CommandBuffer.

Declaration

void SetKeyword(ComputeShader computeShader, ref LocalKeyword keyword, bool value)

Parameters

Type	Name	Description
ComputeShader	computeShader	See CommandBuffer documentation
LocalKeyword	keyword	See CommandBuffer documentation
bool	value	See CommandBuffer documentation

SetKeyword(Material, ref LocalKeyword, bool)

Wraps SetKeyword on a CommandBuffer.

Declaration

void SetKeyword(Material material, ref LocalKeyword keyword, bool value)

Parameters

Type	Name	Description
Material	material	See CommandBuffer documentation
LocalKeyword	keyword	See CommandBuffer documentation
bool	value	See CommandBuffer documentation

SetKeyword(ref GlobalKeyword, bool)

Wraps SetKeyword on a CommandBuffer.

Declaration

void SetKeyword(ref GlobalKeyword keyword, bool value)

Parameters

Type	Name	Description
GlobalKeyword	keyword	See CommandBuffer documentation
bool	value	See CommandBuffer documentation

SetLateLatchProjectionMatrices(Matrix4x4[])

Wraps SetLateLatchProjectionMatrices on a CommandBuffer.

Declaration

void SetLateLatchProjectionMatrices(Matrix4x4[] projectionMat)

Parameters

Type	Name	Description
Matrix4x4[]	projectionMat	See CommandBuffer documentation

SetShadowSamplingMode(RenderTargetIdentifier, ShadowSamplingMode)

Wraps SetShadowSamplingMode on a CommandBuffer.

Declaration

void SetShadowSamplingMode(RenderTargetIdentifier shadowmap, ShadowSamplingMode mode)

Parameters

Type	Name	Description
RenderTargetIdentifier	shadowmap	See CommandBuffer documentation
ShadowSamplingMode	mode	See CommandBuffer documentation

SetSinglePassStereo(SinglePassStereoMode)

Wraps SetSinglePassStereo on a CommandBuffer.

Declaration

void SetSinglePassStereo(SinglePassStereoMode mode)

Parameters

Type	Name	Description
SinglePassStereoMode	mode	See CommandBuffer documentation

SetViewProjectionMatrices(Matrix4x4, Matrix4x4)

Wraps SetViewProjectionMatrices on a CommandBuffer.

Declaration

void SetViewProjectionMatrices(Matrix4x4 view, Matrix4x4 proj)

Parameters

Type	Name	Description
Matrix4x4	view	See CommandBuffer documentation
Matrix4x4	proj	See CommandBuffer documentation

SetViewport(Rect)

Wraps SetViewport on a CommandBuffer.

Declaration

void SetViewport(Rect pixelRect)

Parameters

Type	Name	Description
Rect	pixelRect	See CommandBuffer documentation

SetupCameraProperties(Camera)

Wraps SetupCameraProperties on a CommandBuffer.

Declaration

void SetupCameraProperties(Camera camera)

Parameters

Type	Name	Description
Camera	camera	See CommandBuffer documentation

UnmarkLateLatchMatrix(CameraLateLatchMatrixType)

Wraps UnmarkLateLatchMatrix on a CommandBuffer.

Declaration

void UnmarkLateLatchMatrix(CameraLateLatchMatrixType matrixPropertyType)

Parameters

Type	Name	Description
CameraLateLatchMatrixType	matrixPropertyType	See CommandBuffer documentation

Extension Methods

AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)