docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.Rendering

    Classes

    AdditionalPropertyAttribute

    Attribute used to customize UI display to allow properties only be visible when "Show Additional Properties" is selected

    AnimationCurveParameter

    A VolumeParameter that holds an AnimationCurve value.

    ArrayExtensions

    Array utilities functions

    BitArrayUtilities

    Bit array utility class.

    Blitter

    Various blit (texture copy) utilities for the Scriptable Render Pipelines.

    BoolParameter

    A VolumeParameter that holds a bool value.

    BufferedRTHandleSystem

    Implement a multiple buffering for RenderTextures.

    CameraCaptureBridge

    Bridge class for camera captures.

    CameraSwitcher

    Utility component allowing users to setup many different static camera and cycle through their positions using the Debug Window.

    ClampedFloatParameter

    A VolumeParameter that holds a float value clamped between a minimum and a maximum value.

    ClampedIntParameter

    A VolumeParameter that holds an int value clamped between a minimum and a maximum value.

    ColorParameter

    A VolumeParameter that holds a Color value.

    ColorUtils

    A set of color manipulation utilities.

    CommandBufferPool

    Command Buffer Pool

    ComponentSingleton<TType>

    Singleton of a Component class.

    ConstantBuffer

    Constant Buffer management class.

    ConstantBuffer<CBType>

    An instance of a constant buffer.

    ConstantBufferBase

    The base class of Constant Buffer.

    CoreMatrixUtils

    Set of utility functions for the Core Scriptable Render Pipeline Library related to Matrix operations

    CoreRenderPipelinePreferencesTests

    CoreRPHelpURLAttribute

    Attribute to define the help url

    CoreUnsafeUtils

    Static class with unsafe utility functions.

    CoreUtils

    Set of utility functions for the Core Scriptable Render Pipeline Library

    CoreUtils.Priorities

    Class to store the menu priorities on each top level menu

    CoreUtils.Sections

    Class to store the menu sections

    CubemapParameter

    A VolumeParameter that holds a Cubemap value.

    DebugManager

    Manager class for the Debug Window.

    DebugShapes

    Debug class containing several debug shapes for debugging

    DebugUI

    Debug UI Class

    DebugUI.BitField

    Bitfield enumeration field.

    DebugUI.BoolField

    Boolean field.

    DebugUI.Button

    Button widget.

    DebugUI.ColorField

    Color field.

    DebugUI.Container

    Base class for "container" type widgets, although it can be used on its own (if a display name is set then it'll behave as a group with a header)

    DebugUI.EnumField

    Enumerator field.

    DebugUI.Field<T>

    Generic field - will be serialized in the editor if it's not read-only

    DebugUI.FloatField

    Float field.

    DebugUI.Foldout

    Unity-like foldout that can be collapsed.

    DebugUI.HBox

    Horizontal Layout Container.

    DebugUI.HistoryBoolField

    Boolean field with history.

    DebugUI.HistoryEnumField

    Enumerator field with history.

    DebugUI.IntField

    Integer field.

    DebugUI.Panel

    Root panel class.

    DebugUI.Table

    Array Container.

    DebugUI.Table.Row

    Row Container.

    DebugUI.UIntField

    Unsigned integer field.

    DebugUI.Value

    Read only Value widget.

    DebugUI.VBox

    Vertical Layout Container.

    DebugUI.Vector2Field

    Vector2 field.

    DebugUI.Vector3Field

    Vector3 field.

    DebugUI.Vector4Field

    Vector4 field.

    DebugUI.Widget

    Base class for all debug UI widgets.

    DelegateUtility

    Delegate utility class.

    DictionaryPool<TKey, TValue>

    Dictionary Pool.

    DisplayInfoAttribute

    Attribute used to customize UI display.

    DocumentationInfo

    Documentation Info class.

    DocumentationUtils

    Set of utils for documentation

    DynamicArray<T>

    Generic growable array.

    DynamicResolutionHandler

    The class responsible to handle dynamic resolution.

    FloatParameter

    A VolumeParameter that holds a float value.

    FloatRangeParameter

    A VolumeParameter that holds a Vector2 value holding a range of two float values clamped between a minimum and a maximum value.

    FreeCamera

    Utility Free Camera component.

    GenerateHLSL

    Attribute specifying that HLSL code should be generated.

    GenericPool<T>

    Generic pool.

    HableCurve

    An implementation of Hable's artist-friendly tonemapping curve. http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/

    HableCurve.Segment

    Individual curve segment.

    HableCurve.Uniforms

    An utility class to ease the binding of curve parameters to shaders.

    HaltonSequence

    An utility class to compute samples on the Halton sequence. https://en.wikipedia.org/wiki/Halton_sequence

    HashSetPool<T>

    HashSet Pool.

    HLSLArray

    Attribute defining an HLSL array.

    IntParameter

    A VolumeParameter that holds an int value.

    LayerMaskParameter

    A VolumeParameter that holds a LayerMask value.

    LensFlareCommonSRP

    Common code for all Data-Driven Lens Flare used

    LensFlareComponentSRP

    Data-Driven Lens Flare can be added on any gameobeject

    LensFlareDataElementSRP

    LensFlareDataElementSRP defines collection of parameters describing the behavior a Lens Flare Element.

    LensFlareDataSRP

    LensFlareDataSRP defines a Lens Flare with a set of LensFlareDataElementSRP

    ListBufferExtensions

    Extensions for ListBuffer<T>.

    ListChangedEventArgs<T>

    On List Changed Event Args.

    ListPool<T>

    List Pool.

    MaterialQualityUtilities

    Material Quality utility class.

    MaxFloatParameter

    A VolumeParameter that holds a float value clamped to a max value.

    MaxIntParameter

    A VolumeParameter that holds an int value clamped to a maximum value.

    MinFloatParameter

    A VolumeParameter that holds a float value clamped to a minimum value.

    MinIntParameter

    A VolumeParameter that holds an int value clamped to a minimum value.

    MousePositionDebug

    Provides mouse position for debugging purpose.

    NoInterpClampedFloatParameter

    A VolumeParameter that holds a non-interpolating float value clamped between a minimum and a maximum value.

    NoInterpClampedIntParameter

    A VolumeParameter that holds a non-interpolating int value clamped between a minimum and a maximum value.

    NoInterpColorParameter

    A VolumeParameter that holds a non-interpolating Color value.

    NoInterpCubemapParameter

    A VolumeParameter that holds a non-interpolating Cubemap value.

    NoInterpFloatParameter

    A VolumeParameter that holds a non-interpolating float value.

    NoInterpFloatRangeParameter

    A VolumeParameter that holds a non-interpolating Vector2 value holding a range of two float values clamped between a minimum and a maximum value.

    NoInterpIntParameter

    A VolumeParameter that holds a non-interpolating int value.

    NoInterpMaxFloatParameter

    A VolumeParameter that holds a non-interpolating float value clamped to a maximum value.

    NoInterpMaxIntParameter

    A VolumeParameter that holds a non-interpolating int value that clamped to a maximum value.

    NoInterpMinFloatParameter

    A VolumeParameter that holds a non-interpolating float value clamped to a minimum value.

    NoInterpMinIntParameter

    A VolumeParameter that holds a non-interpolating int value that clamped to a minimum value.

    NoInterpRenderTextureParameter

    A VolumeParameter that holds a non-interpolating RenderTexture value.

    NoInterpTextureParameter

    A VolumeParameter that holds a non-interpolating Texture value.

    NoInterpVector2Parameter

    A VolumeParameter that holds a non-interpolating Vector2 value.

    NoInterpVector3Parameter

    A VolumeParameter that holds a non-interpolating Vector3 value.

    NoInterpVector4Parameter

    A VolumeParameter that holds a non-interpolating Vector4 value.

    ObjectParameter<T>

    A VolumeParameter that holds a serializable class or struct.

    ObjectPool<T>

    Generic object pool.

    ObservableList<T>

    Observable list.

    PackingAttribute

    Attribute defining packing.

    PowerOfTwoTextureAtlas

    Texture atlas with rectangular power of two size.

    ProfilingSampler

    Wrapper around CPU and GPU profiling samplers. Use this along ProfilingScope to profile a piece of code.

    ReloadAttribute

    Attribute specifying information to reload with UnityEngine.Rendering.ResourceReloader. This is only used in the editor and doesn't have any effect at runtime.

    ReloadGroupAttribute

    Attribute specifying that it contains element that should be reloaded. If the instance of the class is null, the system will try to recreate it with the default constructor. Be sure classes using it have default constructor!

    RenderPipelineResources

    Base of resources assets in SRP

    RenderTextureParameter

    A VolumeParameter that holds a RenderTexture value.

    RTHandle

    A RTHandle is a RenderTexture that scales automatically with the camera size. This allows proper reutilization of RenderTexture memory when different cameras with various sizes are used during rendering. RTHandleSystem

    RTHandles

    Default instance of a RTHandleSystem

    RTHandleSystem

    System managing a set of RTHandle textures

    SerializedDictionary<K, V>

    Serialized Dictionary

    SerializedDictionary<K, V, SK, SV>

    SphericalHarmonicsL2Utils

    A collection of utility functions used to access and set SphericalHarmonicsL2 in a more verbose way.

    SurfaceDataAttributes

    Attribute specifying the parameters of a surface data field.

    Texture2DAtlas

    A generic Atlas texture of 2D textures. An atlas texture is a texture collection that collects multiple sub-textures into a single big texture. Sub-texture allocation for Texture2DAtlas is static and will not change after initial allocation. Does not add mipmap padding for sub-textures.

    TextureCurve

    A wrapper around AnimationCurve to automatically bake it into a texture.

    TextureCurveParameter

    A VolumeParameter that holds a TextureCurve value.

    TextureParameter

    A VolumeParameter that holds a Texture value.

    TextureXR

    Utility class providing default textures compatible in any XR setup.

    TileLayoutUtils

    Utility for tiles layout

    UnsafeGenericPool<T>

    Generic pool without collection checks. This class is an alternative for the GenericPool for object that allocate memory when they are being compared. It is the case for the CullingResult class from Unity, and because of this in HDRP HDCullingResults generates garbage whenever we use ==, .Equals or ReferenceEquals. This pool doesn't do any of these comparison because we don't check if the stack already contains the element before releasing it.

    Vector2Parameter

    A VolumeParameter that holds a Vector2 value.

    Vector3Parameter

    A VolumeParameter that holds a Vector3 value.

    Vector4Parameter

    A VolumeParameter that holds a Vector4 value.

    Volume

    A generic Volume component holding a VolumeProfile.

    VolumeComponent

    The base class for all the components that can be part of a VolumeProfile. The Volume framework automatically handles and interpolates any VolumeParameter members found in this class.

    VolumeComponent.Indent

    Local attribute for VolumeComponent fields only. It handles relative indentation of a property for inspector.

    VolumeComponentDeprecated

    An attribute to hide the volume component to be added through Add Override button on the volume component list

    VolumeComponentMenu

    This attribute allows you to add commands to the Add Override popup menu on Volumes.

    VolumeComponentMenuForRenderPipeline

    This attribute allows you to add commands to the Add Override popup menu on Volumes and specify for which render pipelines will be supported

    VolumeManager

    A global manager that tracks all the Volumes in the currently loaded Scenes and does all the interpolation work.

    VolumeParameter

    The base class for all parameters types stored in a VolumeComponent.

    VolumeParameter<T>

    A generic implementation of VolumeParameter. Custom parameters should derive from this class and implement their own behavior.

    VolumeProfile

    An Asset which holds a set of settings to use with a Volume.

    VolumeStack

    Holds the state of a Volume blending update. A global stack is available by default in VolumeManager but you can also create your own using CreateStack() if you need to update the manager with specific settings and store the results for later use.

    XRGraphics

    XRGraphics insulates SRP from API changes across platforms, Editor versions, and as XR transitions into XR SDK

    XRGraphicsAutomatedTests

    Utility class to connect SRP to automated test framework.

    XRUtils

    XR Utility class.

    Structs

    BitArray128

    Bit array of size 128.

    BitArray16

    Bit array of size 16.

    BitArray256

    Bit array of size 256.

    BitArray32

    Bit array of size 32.

    BitArray64

    Bit array of size 64.

    BitArray8

    Bit array of size 8.

    CoreUnsafeUtils.FixedBufferStringQueue

    Fixed Buffer String Queue class.

    DebugUI.Foldout.ContextMenuItem

    Context menu item.

    DebugUI.Widget.NameAndTooltip

    Helper struct to allow more compact initialization of widgets.

    GlobalDynamicResolutionSettings

    User-facing settings for dynamic resolution.

    ListBuffer<T>

    A list that stores value on a provided memory buffer.

    Usually use this to have a list on stack allocated memory.

    ObjectPool<T>.PooledObject

    Pooled object.

    ProfilingSample

    Profiling Sampler class.

    ProfilingScope

    Scoped Profiling markers

    RTHandleProperties

    List of properties of the RTHandle System for the current frame.

    ShaderGenUInt4

    This type needs to be used when generating unsigned integer arrays for constant buffers.

    SphericalHarmonicsL1

    VolumeIsolationScope

    A scope in which a Camera filters a Volume.

    Interfaces

    CoreUnsafeUtils.IKeyGetter<TValue, TKey>

    Key Getter interface.

    DebugUI.IContainer

    Interface for widgets that can contain other widgets.

    DebugUI.IValueField

    Any widget that implements this will be considered for serialization (only if the setter is set and thus is not read-only)

    IBitArray

    IBitArray interface.

    IDebugData

    IDebugData interface.

    IVirtualTexturingEnabledRenderPipeline

    By implementing this interface, a render pipeline can indicate to external code it supports virtual texturing.

    IVolume

    An interface for Volumes

    Enums

    APVConstantBufferRegister

    Defines the constant buffer register that will be used as binding point for the Probe Volumes constant buffer.

    ClearFlag

    Render Textures clear flag. This is an legacy alias for RTClearFlags.

    DebugUI.Flags

    Flags for Debug UI widgets.

    DepthBits

    Bit depths of a Depth render texture. Some values may not be supported on all platforms.

    DynamicResolutionHandler.UpsamplerScheduleType

    The scheduling mechanism to apply upscaling.

    DynamicResolutionType

    Types of dynamic resolution that can be requested. Note that if Hardware is selected, but not available on the platform, the system will fallback to Software.

    DynamicResScalePolicyType

    The type of dynamic resolution scaler. It essentially defines what the output of the scaler is expected to be.

    DynamicResScalerSlot

    The source slots for dynamic resolution scaler. Defines registers were the scalers assigned are stored. By default the User one is always used

    DynamicResUpscaleFilter

    Types of filters that can be used to upscale rendered result to native resolution.

    FieldPacking

    Field packing scheme.

    FieldPrecision

    Field Precision

    MaterialQuality

    Material quality flags.

    MSAASamples

    Number of MSAA samples.

    PackingRules

    Packing Rules for structs.

    ReloadAttribute.Package

    Lookup method for a resource.

    SRPLensFlareBlendMode

    SRPLensFlareBlendMode defined the available blend mode for each LensFlareElement

    SRPLensFlareDistribution

    SRPLensFlareDistribution defined how we spread the flare element when count > 1

    SRPLensFlareType

    SRPLensFlareType which can be an image of a procedural shape If change order or add new member, need to update preview shader: LensFlareDataDrivenPreview.shader

    XRGraphics.StereoRenderingMode

    Stereo Rendering Modes.

    Delegates

    ListChangedEventHandler<T>

    List changed event handler.

    PerformDynamicRes

    The format of the delegate used to perofrm dynamic resolution.

    ScaleFunc

    Scaled function used to compute the size of a RTHandle for the current frame.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023