Class HDAdditionalCameraData
Additional component that holds HDRP specific parameters for Cameras.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[AddComponentMenu("")]
[DisallowMultipleComponent]
[ExecuteAlways]
[RequireComponent(typeof(Camera))]
public class HDAdditionalCameraData : MonoBehaviour, IVersionable<HDAdditionalCameraData.Version>, IDebugData, IAdditionalData
Fields
Name | Description |
---|---|
SMAAQuality | Quality of the anti-aliasing when using SMAA. |
TAAQuality | Quality of the anti-aliasing when using TAA. |
allowDeepLearningSuperSampling | Allow NVIDIA Deep Learning Super Sampling (DLSS) on this camera. |
allowDynamicResolution | Allows dynamic resolution on buffers linked to this camera. |
antialiasing | Anti-aliasing mode. |
backgroundColorHDR | HDR color used for clearing the camera background. |
clearColorMode | Clear mode for the camera background. |
clearDepth | Clear depth as well as color. |
customRenderingSettings | Allows you to override the default frame settings for this camera. |
deepLearningSuperSamplingQuality | Selects a performance quality setting for NVIDIA Deep Learning Super Sampling (DLSS) for this camera of this project. |
deepLearningSuperSamplingSharpening | Sets the Sharpening value for NVIDIA Deep Learning Super Sampling (DLSS) for this camera. |
deepLearningSuperSamplingUseCustomAttributes | If set to true, NVIDIA Deep Learning Super Sampling (DLSS) will utilize the Quality setting set on this camera instead of the one specified in the quality asset of this project. |
deepLearningSuperSamplingUseCustomQualitySettings | If set to true, NVIDIA Deep Learning Super Sampling (DLSS) will utilize the Quality setting set on this camera instead of the one specified in the quality asset. |
deepLearningSuperSamplingUseOptimalSettings | Sets the sharpness and scale automatically for NVIDIA Deep Learning Super Sampling (DLSS) for this camera, depending on the values of quality settings. |
defaultFrameSettings | When using default frame settings, specify which type of frame settings to use. |
dithering | Use dithering to filter out minor banding. |
exposureTarget | The object used as a target for centering the Exposure's Procedural Mask metering mode when target object option is set (See Exposure Volume Component). |
flipYMode | Vertical flip mode. |
fsrOverrideSharpness | If set to true, AMD FidelityFX Super Resolution (FSR) will utilize the sharpness setting set on this camera instead of the one specified in the quality asset. |
fsrSharpness | Sets this camera's sharpness value for AMD FidelityFX Super Resolution. |
fullscreenPassthrough | Skips rendering settings to directly render in fullscreen (Useful for video). |
hasPersistentHistory | Enable to retain history buffers even if the camera is disabled. |
invertFaceCulling | Invert face culling. |
materialMipBias | Mip bias used on texture samplers during material rendering |
nonObliqueProjectionGetter | Specify a custom getter for non oblique projection matrix. |
physicalParameters | Physical camera parameters. |
probeLayerMask | Probe layer mask. |
renderingPathCustomFrameSettingsOverrideMask | Mask specifying which frame settings are overridden when using custom frame settings. |
screenCoordScaleBias | Transform used when Screen Coordinates Override is active. |
screenSizeOverride | Screen size used when Screen Coordinates Override is active. |
stopNaNs | Use a pass to eliminate NaNs contained in the color buffer before post-processing. |
taaAntiFlicker | Drive the anti-flicker mechanism. With high values flickering might be reduced, but it can lead to more ghosting or disocclusion artifacts. |
taaAntiHistoryRinging | When enabled, ringing artifacts (dark or strangely saturated edges) caused by history sharpening will be improved. This comes at a potential loss of sharpness upon motion. |
taaBaseBlendFactor | Determines how much the history buffer is blended together with current frame result. Higher values means more history contribution. |
taaHistorySharpening | Strength of the sharpening of the history sampled for TAA. |
taaJitterScale | Scale to apply to the jittering applied when TAA is enabled. |
taaMotionVectorRejection | Larger is this value, more likely history will be rejected when current and reprojected history motion vector differ by a substantial amount. Larger values can decrease ghosting but will also reintroduce aliasing on the aforementioned cases. |
taaRingingReduction | How much to reduce the ringing from the TAA post-process sharpening. Note that some ringing might be visually desirable and that any value different than 0 will incur into a small additional cost. |
taaSharpenMode | How is the sharpening run sharpening. |
taaSharpenStrength | Strength of the sharpening component of temporal anti-aliasing. |
volumeAnchorOverride | Optional transform override for the position where volumes are interpolated. |
volumeLayerMask | Layer mask used to select which volumes will influence this camera. |
xrRendering | Enable XR rendering. |
Properties
Name | Description |
---|---|
aovRequests | Use this property to get the aov requests. It is never null. |
hasCustomRender | True if any Custom Render event is registered for this camera. |
isEditorCameraPreview | Unity support two type of preview: Camera preview and material preview. This property allow to know that we are an editor camera preview when the type is preview. |
renderingPathCustomFrameSettings | Custom frame settings. |
Methods
Name | Description |
---|---|
CopyTo(HDAdditionalCameraData) | Copy HDAdditionalCameraData. |
GetGraphicsBuffer(BufferAccessType) | Returns the requested graphics buffer. Users should use the requestGraphicsBuffer event to make sure that the required buffers are requested first. Note that depending on the current frame settings some buffers may not be available. |
GetNonObliqueProjection(Camera) | Returns the non oblique projection matrix for this camera. |
SetAOVRequests(AOVRequestDataCollection) | Set AOV requests to use. |
Events
Name | Description |
---|---|
customRender | Event used to override HDRP rendering for this particular camera. |
requestGraphicsBuffer | RequestAccessDelegate used to request access to various buffers of this camera. |