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
BoolScalableSettingValue
An bool scalable setting value
BuiltinSkyParameters
Parameters passed to sky rendering functions.
CameraClampModeParameter
A VolumeParameter that holds a CameraClampMode value.
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.
CloudLayer
Cloud Layer Volume Component. This component setups the Cloud Layer for rendering.
CloudLayer.CloudMap
Cloud Map Volume Parameters. This groups parameters for one cloud map layer.
CloudLayerEnumParameter<T>
Enum volume parameter.
CloudRenderer
Base class for cloud rendering.
CloudSettings
Base class for custom Cloud Settings.
CloudUniqueID
This attribute is used to associate a unique ID to a cloud class. This is needed to be able to automatically register cloud classes and avoid collisions and refactoring class names causing data compatibility issues.
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.
ComponentUtility
Utility class for HDRP specific components.
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.
DebugOverlay
Utility class for debug overlay coordinates.
DecalProjector
Decal Projector component.
DecalsDebugSettings
Decal debug settings.
DensityVolume
Deprecated DensityVolume
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
FloatScalableSettingValue
An float scalable setting value
FocusDistanceModeParameter
A VolumeParameter that holds a FocusDistanceModeParameter value.
Fog
Fog Volume Component.
FogColorParameter
Fog Color parameter.
FogControlParameter
A VolumeParameter that holds a ExposureMode value.
FogDenoisingModeParameter
A VolumeParameter that holds a FogDenoisingMode value.
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.
HDDynamicResolutionPlatformCapabilities
Contains utility methods for HDRP to query DRS Capabilities.
HDLightTypeExtension
Extension class for the HDLightTypeAndShape type.
HDMaterialProperties
Material property names used in HDRP Shaders.
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.
HDShaderPassNames
Pass names and shader ids used in HDRP. these names can be used as filters when rendering objects in a custom pass or a DrawRenderers() call.
HDShadowSettings
Settings for shadows.
HDUtils
Various utility functions for HDRP.
HDVolumeDebugSettings
Volume debug settings.
IndirectLightingController
Component that allow you to control the indirect specular and diffuse intensity
IndirectLightingController.LightLayerEnumParameter
Sky Ambient Mode volume parameter.
InfluenceVolume
An influence volume.
IntScalableSetting
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.
LocalVolumetricFog
Local Volumetric Fog class.
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.
ObjectIDCustomPass
Custom Pass that draws Object IDs
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.
PhysicallyBasedSkyModelParameter
Physically Based Sky model volume parameter.
PlanarReflectionProbe
The planar reflection probe component.
ProbeSettings.PlanarReflectionAtlasResolutionScalableSettingValue
An int scalable setting value
ProbeSettingsUtilities
Utilities for ProbeSettings
ProceduralSky
ProxyVolume
A proxy volume.
This volume approximate the scene geometry with simple mathematical shapes.
RayCastingModeParameter
A VolumeParameter that holds a RayCastingMode value.
RayMarchingFallbackHierarchyParameter
A VolumeParameter that holds RayMarchingFallbackHierarchy value.
RayTracingFallbackHierachyParameter
A VolumeParameter that holds a RayTracingFallbackHierachy value.
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.
RenderPipelineSettings.PlanarReflectionAtlasResolutionScalableSetting
Represents resolution settings for planar reflections.
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.
SSRAlgoParameter
Screen Space Reflection Algorithm Type volume parameter.
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.
TargetMidGrayParameter
A VolumeParameter that holds a TargetMidGray value.
Tonemapping
A volume component that holds settings for the Tonemapping effect.
TonemappingModeParameter
A VolumeParameter that holds a TonemappingMode value.
TransparencyDebugSettings
Transparency debug settings.
UintScalableSetting
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.
VolumetricClouds
A volume component that holds settings for the ambient occlusion.
VolumetricClouds.CloudControlParameter
A VolumeParameter that holds a VolumetricClouds.CloudControl value.
VolumetricClouds.CloudErosionNoiseParameter
A VolumeParameter that holds a VolumetricClouds.CloudErosionNoise value.
VolumetricClouds.CloudFadeInModeParameter
A VolumeParameter that holds a VolumetricClouds.CloudControl value.
VolumetricClouds.CloudMapResolutionParameter
A VolumeParameter that holds a VolumetricClouds.CloudMapResolution value.
VolumetricClouds.CloudPresetsParameter
A VolumeParameter that holds a VolumetricClouds.CloudControl value.
VolumetricClouds.CloudShadowResolutionParameter
A VolumeParameter that holds a VolumetricClouds.CloudControl value.
WhiteBalance
A volume component that holds settings for the White Balance effect.
WindOrientationParameter
Wind Orientation parameter.
WindParameter
Generic wind volume parameter.
WindSpeedParameter
Wind speed parameter.
Structs
AOVRequest
Use this request to define how to render an AOV.
AOVRequestData
Describes a frame pass.
BuiltinSunCookieParameters
Parameters passed to sun light cookie rendering functions.
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.
CookieParameters
Parameters to override sun light cookie.
CustomPassContext
Context used when executing custom passes
CustomPassUtils.DisableSinglePassRendering
Disable the single-pass rendering (use in XR)
CustomPassUtils.OverrideCameraRendering
Overrides the current camera, changing all the matrices and view parameters for the new one. It allows you to render objects from another camera, which can be useful in custom passes for example.
DensityVolumeArtistParameters
Deprecated DensityVolumeArtistParameters
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.
HDPhysicalCamera
Holds the physical settings set on cameras.
HDProbe.RenderData
Store the settings computed during a rendering
HDShadowInitParameters
Shadows Global Settings.
HDShadowInitParameters.HDShadowAtlasInitParams
Shadow Atlases parameters.
LocalVolumetricFogArtistParameters
Artist-friendly Local Volumetric Fog parametrization.
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.
WindParameter.WindParamaterValue
Wind parameter value.
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.
CameraClampMode
Determine how the component of the motion vectors coming from the camera are clamped.
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.
CloudDistortionMode
Cloud Distortion Mode.
CloudMapMode
Cloud Map Mode.
CloudResolution
Resolution of the cloud texture.
CloudShadowsResolution
Resolution of the cloud shadow.
CloudType
Informative enumeration containing CloudUniqeIDs already used by HDRP. When users write their own cloud type, they can use any ID not present in this enumeration or in their project.
ClusterDebugMode
Cluster visualization mode.
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.
DecalLayerEnum
Decal Layers.
DecalScaleMode
The scaling mode to apply to decals that use the Decal Projector.
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.
FocusDistanceMode
Options for the source of the focus distance HDRP uses in the depth of field calculations.
FogColorMode
Fog Color Mode.
FogControl
Options that control the quality and resource intensity of the volumetric fog.
FogDenoisingMode
Options that control which denoising algorithms Unity should use on the volumetric fog signal.
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
HDRISky.DistortionMode
Distortion Mode.
HDRISky.Version
The version used during the migration
HDShadowFilteringQuality
Shadow Filtering Quality
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
LocalVolumetricFogFalloffMode
LocalVolumetricFogResolution
Possible values for one element of the Local Volumetric Fog atlas.
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
MSAAMode
Defines the level of MSAA for the camera.
PhysicallyBasedSky.Version
The version used during the migration
PhysicallyBasedSkyModel
The model used to control the complexity of the simulation.
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
RayCastingMode
This defines which ray casting technique should be used.
RayCountValues
The different ray count values that can be asked for.
RayMarchingFallbackHierarchy
This defines the order in which the fall backs are used if a screen space global illumination ray misses.
RayTracingFallbackHierachy
This defines the order in which the fall backs are used if a ray tracing misses.
RayTracingMode
This defines which version of an effect should be used.
ReflectionAndPlanarProbeFormat
Available graphic formats for the cube and planar reflection probes.
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.
ScreenSpaceReflectionAlgorithm
Screen Space Reflection Algorithm
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.
TargetMidGray
The target grey value used by the exposure system. Note this is equivalent of changing the calibration constant K on the used virtual reflected light meter.
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.
VolumetricClouds.CloudControl
Control mode for the volumetric clouds.
VolumetricClouds.CloudErosionNoise
Controls the erosion noise used for the clouds.
VolumetricClouds.CloudFadeInMode
The set mode in which the clouds fade in when close to the camera
VolumetricClouds.CloudMapResolution
Resolution of the volumetric clouds map.
VolumetricClouds.CloudPresets
The set of available presets for the simple cloud control mode.
VolumetricClouds.CloudShadowResolution
Resolution of the volumetric clouds shadow.
WindParameter.WindOverrideMode
Parameter override mode.
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.