Namespace UnityEngine.Rendering.HighDefinition | High Definition RP | 9.0.0-preview.71
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.Rendering.HighDefinition

    Classes

    AdaptationModeParameter

    A VolumeParameter that holds a AdaptationMode value.

    AmbientOcclusion

    A volume component that holds settings for the ambient occlusion.

    AOVRequestBuilder

    Utility to build frame passes.

    AOVRequestDataCollection

    A collection of frame passes. To build one, AOVRequestBuilder

    BackplateTypeParameter

    Backplate Type volume parameter.

    Bloom

    A volume component that holds settings for the Bloom effect.

    BloomResolutionParameter

    A VolumeParameter that holds a BloomResolution value.

    BlueNoise

    A bank of pre-generated blue noise textures.

    BoolScalableSetting

    ScalableSetting<T>.

    BoolScalableSettingValue

    An bool scalable setting value

    BuiltinSkyParameters

    Parameters passed to sky rendering functions.

    CameraSettingsUtilities

    Utilities for CameraSettings.

    CascadeEndBorderParameter

    Cascade End Border parameter.

    CascadePartitionSplitParameter

    Cascade Partition split parameter.

    ChannelMixer

    A volume component that holds settings for the Channel Mixer effect.

    ChromaticAberration

    A volume component that holds settings for the Chromatic Aberration effect.

    ColorAdjustments

    A volume component that holds settings for the Color Adjustments effect.

    ColorCurves

    A volume component that holds settings for the Color Adjustments effect.

    ColorPickerDebugSettings

    Color Pcker debug settings.

    ContactShadows

    A volume component that holds settings for the Contact Shadows effect.

    CustomPass

    Class that holds data and logic for the pass to be executed

    CustomPassAOVBuffers

    Describes the type of custom pass buffer that will be exported with the AOV API.

    CustomPassUtils

    A set of custom pass utility function to help you build your effects

    CustomPassVolume

    Unity Monobehavior that manages the execution of custom passes. It provides

    CustomPostProcessVolumeComponent

    Volume component class to inherit when you implement a custom post process

    DebugDisplaySettings

    Class managing debug display in HDRP.

    DebugDisplaySettings.DebugData

    Debug data.

    DecalProjector

    Decal Projector component.

    DecalsDebugSettings

    Decal debug settings.

    DensityVolume

    Density volume class.

    DepthOfField

    A volume component that holds settings for the Depth Of Field effect.

    DepthOfFieldModeParameter

    A VolumeParameter that holds a DepthOfFieldMode value.

    DepthOfFieldResolutionParameter

    A VolumeParameter that holds a DepthOfFieldResolution value.

    DrawRenderersCustomPass

    DrawRenderers Custom Pass

    EnvUpdateParameter

    Environment Update volume parameter.

    Exposure

    A volume component that holds settings for the Exposure effect.

    ExposureModeParameter

    A VolumeParameter that holds a ExposureMode value.

    FalseColorDebugSettings

    False Color debug mpde settings.

    FilmGrain

    A volume component that holds settings for the Film Grain effect.

    FilmGrainLookupParameter

    A VolumeParameter that holds a FilmGrainLookup value.

    FloatScalableSetting

    ScalableSetting<T>.

    FloatScalableSettingValue

    An float scalable setting value

    Fog

    Fog Volume Component.

    FogColorParameter

    Fog Color parameter.

    FullScreenCustomPass

    FullScreen Custom Pass

    GameObjectExtension

    Extensions to create new Lights in HDRP.

    GlobalIllumination

    A volume component that holds settings for the global illumination (screen space and ray traced).

    GlobalLightingQualitySettings

    Global lighting quality settings.

    GlobalPostProcessingQualitySettings

    Post Processing Quality Settings.

    GradientSky

    Gradient Sky Volume Component. This component setups gradient sky for rendering.

    HDAdditionalCameraData

    Additional component that holds HDRP specific parameters for Cameras.

    HDAdditionalLightData

    HDRP Additional light data component. It contains the light API and fields used by HDRP.

    HDAdditionalReflectionData

    Additional component used to store settings for HDRP's reflection probes.

    HDAdditionalReflectionDataExtensions

    Utilities for reflection probes.

    HDCachedShadowManager

    The class responsible to handle cached shadow maps (shadows with Update mode set to OnEnable or OnDemand).

    HDCamera

    HDCamera class. This class holds all information for a given camera. Constants used for shading as well as buffers persistent from one frame to another etc.

    HDLightTypeExtension

    Extension class for the HDLightTypeAndShape type.

    HDPhysicalCamera

    Holds the physical settings set on cameras.

    HDProbe

    Base class for reflection like probes.

    HDRenderPipeline

    High Definition Render Pipeline class.

    HDRenderPipelineAsset

    High Definition Render Pipeline asset.

    HDRenderUtilities

    Various utilities to perform rendering with HDRP

    HDRISky

    HDRI Sky Volume Component. This component setups HDRI sky for rendering.

    HDShadowSettings

    Settings for shadows.

    HDUtils

    Various utility functions for HDRP.

    IndirectLightingController

    Component that allow you to control the indirect specular and diffuse intensity

    InfluenceVolume

    An influence volume.

    IntScalableSetting

    ScalableSetting<T>.

    IntScalableSettingValue

    An int scalable setting value

    LensDistortion

    A volume component that holds settings for the Lens Distortion effect.

    LiftGammaGain

    A volume component that holds settings for the Lift, Gamma, Gain effect.

    LightCluster

    A volume component that holds settings for the ray tracing light cluster.

    LightingDebugSettings

    Lighting Debug Settings.

    LuminanceSourceParameter

    A VolumeParameter that holds a LuminanceSource value.

    MaterialDebugSettings

    Material Debug Settings.

    MeteringModeParameter

    A VolumeParameter that holds a MeteringMode value.

    MicroShadowing

    A volume component that holds settings for the Micro Shadows effect.

    MipMapDebugSettings

    Mîp map debug Settings.

    MotionBlur

    A volume component that holds settings for the Motion Blur effect.

    PaniniProjection

    A volume component that holds settings for the Panini Projection effect.

    PathTracing

    A volume component that holds settings for the Path Tracing effect.

    PhysicallyBasedSky

    Physically Based Sky Volume Component.

    PlanarReflectionProbe

    The planar reflection probe component.

    ProbeSettingsUtilities

    Utilities for ProbeSettings

    ProceduralSky

    ProxyVolume

    A proxy volume.

    This volume approximate the scene geometry with simple mathematical shapes.

    RayTracingModeParameter

    A VolumeParameter that holds a RayTracingMode value.

    RayTracingSettings

    A volume component that holds the general settings for ray traced effects.

    RecursiveRendering

    Recursive Rendering Volume Component. This component setups recursive rendering.

    ReflectionProxyVolumeComponent

    Use this components to define a proxy volume for the reflection probes.

    ScalableSetting<T>

    Define the level's value for a ScalableSettingValue<T>.

    Use this setting in an asset that defines the quality settings for a specific platform. Then those settings can be used with the ScalableSettingValue<T> to get the actual value to use.

    If you intend to serialize this type, use specialized version instead. (IntScalableSetting).

    ScalableSettingLevelParameter

    Scalable Quality Level Parameter.

    ScalableSettingSchema

    Defines the number of levels and the level names for a scalable setting.

    This class is intended to be immutable. As it is a reference type, a schema should be instantiated only once and used as reference everywhere.

    ScalableSettingValue<T>

    Define a value that can be either customized or fetched from a current quality settings' sub level.

    If you intend to serialize this type, use specialized version instead. (IntScalableSetting).

    ScreenSpaceReflection

    A volume component that holds settings for screen space reflection and ray traced reflections.

    ScreenSpaceRefraction

    A volume component that holds settings for the Screen Space Refraction effect.

    ShadowsMidtonesHighlights

    A volume component that holds settings for the Shadows, Midtones, Highlights effect.

    SkyAmbientModeParameter

    Sky Ambient Mode volume parameter.

    SkyIntensityParameter

    Sky Intensity volume parameter.

    SkyRenderer

    Base class for sky rendering.

    SkySettings

    Base class for custom Sky Settings.

    SkyUniqueID

    This attribute is used to associate a unique ID to a sky class. This is needed to be able to automatically register sky classes and avoid collisions and refactoring class names causing data compatibility issues.

    SplitToning

    A volume component that holds settings for the Split Toning effect.

    StaticLightingSky

    Class controlling which sky is used for static and baked lighting.

    SubSurfaceScattering

    Subsurface scattering volume component. This component setups subsurface scattering for ray-tracing.

    Tonemapping

    A volume component that holds settings for the Tonemapping effect.

    TonemappingModeParameter

    A VolumeParameter that holds a TonemappingMode value.

    TransparencyDebugSettings

    Transparency debug settings.

    UintScalableSetting

    ScalableSetting<T>.

    UintScalableSettingValue

    An uint scalable setting value

    Vignette

    A volume component that holds settings for the Vignette effect.

    VignetteModeParameter

    A VolumeParameter that holds a VignetteMode value.

    VisualEnvironment

    Visual Environment Volume Component. This component setups the sky used for rendering as well as the way ambient probe should be computed.

    VolumeComponentWithQuality

    Volume Component that uses Quality Settings.

    VolumeDebugSettings

    Volume debug settings.

    WhiteBalance

    A volume component that holds settings for the White Balance effect.

    Structs

    AOVRequest

    Use this request to define how to render an AOV.

    AOVRequestData

    Describes a frame pass.

    CameraPositionSettings

    Defines how the view matrix is provided to the camera.

    CameraSettings

    Contains all settings required to setup a camera in HDRP.

    CameraSettings.BufferClearing

    Defines how color and depth buffers are cleared.

    CameraSettings.Culling

    Defines the culling settings of the camera.

    CameraSettings.Frustum

    Defines the projection matrix of the camera.

    CameraSettings.Volumes

    Defines how the volume framework is queried.

    CameraSettingsOverride

    The overriden fields of a camera settings.

    CustomPassContext

    Context used when executing custom passes

    DensityVolumeArtistParameters

    Artist-friendly density volume parametrization.

    FrameSettings

    Per renderer and per frame settings.

    FrameSettingsOverrideMask

    BitField that state which element is overridden.

    Frustum

    Frustum class.

    GlobalDecalSettings

    Global Decal Settings.

    GlobalLightLoopSettings

    Global Light Loop Settings.

    GlobalLowResolutionTransparencySettings

    Global Low Resolution Transparency Settings.

    GlobalPostProcessSettings

    Project-wide settings related to post-processing.

    HDAdditionalCameraData.BufferAccess

    Structure used to access graphics buffers for this camera.

    HDCamera.ViewConstants

    Structure containing all shader view related constants for this camera.

    HDProbe.RenderData

    Store the settings computed during a rendering

    HDShadowInitParameters

    Shadows Global Settings.

    HDShadowInitParameters.HDShadowAtlasInitParams

    Shadow Atlases parameters.

    MigrationDescription<TVersion, TTarget>

    Describe migration steps to perform when upgrading from one version of an object to another.

    MigrationStep<TVersion, TTarget>

    Define a migration step.

    ProbeCapturePositionSettings

    Settings to use when capturing a probe.

    ProbeSettings

    Settings that defines the rendering of a probe.

    ProbeSettings.Frustum

    Describe how frustum is handled when rendering probe.

    ProbeSettings.Lighting

    Lighting parameters for the probe.

    ProbeSettings.ProxySettings

    Settings of this probe in the current proxy.

    RenderOutputProperties

    Properties computed during a frame rendering.

    RenderPipelineSettings

    HDRP Render Pipeline Settings.

    RenderPipelineSettings.LightSettings

    Light Settings.

    ScalableSettingSchemaId

    Identifies uniquely a ScalableSettingSchema.

    Use UnityEngine.Rendering.HighDefinition.ScalableSettingSchema.GetSchemaOrNull(UnityEngine.Rendering.HighDefinition.ScalableSettingSchemaId) to get a schema.

    Interfaces

    IPostProcessComponent

    Implement this interface on every post process volumes

    IVersionable<TVersion>

    Implement this interface to use with MigrationDescription<TVersion, TTarget>

    Enums

    AdaptationMode

    Methods that HDRP uses to change the exposure when the Camera moves from dark to light and vice versa.

    AOVBuffers

    Buffers available in HDRP

    AreaLightShape

    Shape of an area light

    BackplateType

    Backplate Type for HDRISKy.

    BloomResolution

    The resolution at which HDRP processes the bloom effect.

    CameraPositionSettings.Mode

    Defines the method to use when computing the view matrix.

    CameraSettings.Frustum.Mode

    Defines how the projection matrix is computed.

    CameraSettingsFields

    A bit flag for each camera settings.

    ColorPickerDebugMode

    Color Picker Debug Mode.

    CookieAtlasGraphicsFormat

    Available graphic formats for the cookie atlas texture.

    CookieAtlasResolution

    Possible values for the texture 2D size used for cookies.

    CookieMode

    Cookie Mode

    CubeCookieResolution

    Possible values for the cubemap texture size used for cookies.

    CubeReflectionResolution

    Possible values for the cubemap texture size used for reflection probes.

    CustomPass.RenderQueueType

    Render Queue filters for the DrawRenderers custom pass

    CustomPass.TargetBuffer

    Used to select the target buffer when executing the custom pass

    CustomPassAOVBuffers.OutputType

    Specifies which output type to export.

    CustomPassInjectionPoint

    List all the injection points available for HDRP

    CustomPostProcessInjectionPoint

    Custom Post Processing injection points.

    DebugFullScreen

    Output a specific debug mode.

    DebugLightFilterMode

    Debug Light Filtering.

    DebugLightingMode

    Full Screen Lighting Debug Mode.

    DebugLightLayersMask

    Debug Light Layers Filtering.

    DebugMipMapMode

    Mip Map Debug Mode.

    DebugMipMapModeTerrainTexture

    Terrain mip map debug mode.

    DepthOfFieldMode

    Focusing modes for the depth of field effect.

    DepthOfFieldResolution

    The resolution at which HDRP processes the depth of field effect.

    DrawRenderersCustomPass.ShaderPass

    HDRP Shader passes

    EnvironmentUpdateMode

    Environment lighting update mode.

    ExposureDebugMode

    Exposure debug mode.

    ExposureMode

    Methods that HDRP uses to process exposure.

    FilmGrainLookup

    Presets for the FilmGrain effect.

    FogColorMode

    Fog Color Mode.

    FrameSettingsField

    Collection of settings used for rendering the frame.

    FrameSettingsRenderType

    Type of entity on which frame settings are applied.

    FullScreenDebugMode

    Full Screen Debug Mode.

    GradingLutFormat

    Available color grading LUT formats.

    HDAdditionalCameraData.AntialiasingMode

    Anti-aliasing mode.

    HDAdditionalCameraData.BufferAccessType

    Type of buffers that can be accessed for this camera.

    HDAdditionalCameraData.ClearColorMode

    Clear mode for the camera background.

    HDAdditionalCameraData.FlipYMode

    How the camera should handle vertically flipping the frame at the end of rendering.

    HDAdditionalCameraData.SMAAQualityLevel

    SMAA quality level.

    HDAdditionalCameraData.TAAQualityLevel

    TAA quality level.

    HDAdditionalCameraData.Version

    Define migration versions of the HDAdditionalCameraData

    HDCameraFrameHistoryType

    History buffers available in HDCamera.

    HDLightType

    Type of an HDRP Light.

    HDLightTypeAndShape

    Type of an HDRP Light including shape

    HDProbe.Version

    The version used during the migration

    InfluenceShape

    The shape of the influence volume

    LightingProperty

    Engine lighting property.

    LightLayerEnum

    Light Layers.

    LightUnit

    Unit of the lights supported in HDRP

    LightVolumeDebug

    Light Volume Debug Mode.

    LitShaderMode

    Helper to handle Deferred or Forward but not both

    LODBiasMode

    Defines how the LODBias value is computed.

    LowResTransparentUpsample

    Low resolution transparency upsample type..

    LuminanceSource

    Luminance source that HDRP uses to calculate the current Scene exposure.

    MaximumLODLevelMode

    Defines how the MaximumLOD is computed.

    MeteringMode

    Metering methods that HDRP uses the filter the luminance source

    PlanarReflectionAtlasResolution

    Possible values for the texture 2D size used for planar reflection probes.

    PostProcessBufferFormat

    Format of intermediate buffers for post processing.

    ProbeSettings.Frustum.FOVMode

    The FOV mode of a probe.

    ProbeSettings.Mode

    The rendering mode of the probe.

    ProbeSettings.ProbeType

    The type of the probe.

    ProbeSettings.RealtimeMode

    Realtime mode of the probe.

    ProbeSettingsFields

    A bitflags for the probe settings field.

    ProxyShape

    The shape of the proxy volume

    RayCountValues

    The different ray count values that can be asked for.

    RayTracingMode

    This defines which version of an effect should be used.

    RenderPipelineSettings.ColorBufferFormat

    Color Buffer format.

    RenderPipelineSettings.CustomBufferFormat

    Custom Buffers format.

    RenderPipelineSettings.SupportedLitShaderMode

    Supported Lit Shader Mode.

    RenderPipelineSettings.SupportedRayTracingMode

    Supported Ray Tracing Mode.

    ScalableSettingLevelParameter.Level

    Quality levels.

    ScreenSpaceShadowFormat

    Screen Space Shadows format.

    ShadowMapDebugMode

    Shadow Maps Debug Mode.

    ShadowUpdateMode

    Shadow Update mode

    SkyAmbientMode

    Sky Ambient Mode.

    SkyIntensityMode

    Sky Intensity Mode.

    SkyResolution

    Resolution of the sky reflection cubemap.

    SkyType

    Informative enumeration containing SkyUniqeIDs already used by HDRP. When users write their own sky type, they can use any ID not present in this enumeration or in their project.

    SpotLightShape

    Shape of a spot light.

    SssQualityMode

    Defines how the SssSampleBudget is computed.

    TileClusterCategoryDebug

    Tile and Cluster Debug Categories.

    TileClusterDebug

    Tile and Cluster Debug Mode.

    TonemappingMode

    Available tonemapping modes.

    UserStencilUsage

    Stencil bit exposed to user and not reserved by HDRP. Note that it is important that the Write Mask used in conjunction with these bits includes only this bits. For example if you want to tag UserBit0, the shaderlab code for the stencil state setup would look like:

    WriteMask 64 // Value of UserBit0 Ref 64 // Value of UserBit0 Comp Always Pass Replace

    Or if for example you want to write UserBit0 and zero out the UserBit1, the shaderlab code for the stencil state setup would look like:

    WriteMask MyWriteMask // with MyWriteMask define in C# as MyWriteMask = (UserStencilUsage.UserBit0 | UserStencilUsage.UserBit1) Ref MyRef // with MyRef define in C# as MyRef = UserStencilUsage.UserBit0 Comp Always Pass Replace

    VignetteMode

    The mode HDRP uses to display the vignette effect.

    Delegates

    AOVRequestBufferAllocator

    Called to allocate a RTHandle for a specific AOVBuffer.

    AOVRequestCustomPassBufferAllocator

    Called to allocate a RTHandle for a specific custom pass AOVBuffer.

    FramePassCallback

    Called when the rendering has completed.

    FramePassCallbackEx

    Called when the rendering has completed.

    HDAdditionalCameraData.NonObliqueProjectionGetter

    Returns the non oblique projection matrix for a particular camera.

    HDAdditionalCameraData.RequestAccessDelegate

    Delegate used to request access to various buffers of this camera.

    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