Class HDRenderUtilities
Various utilities to perform rendering with HDRP
Inheritance
HDRenderUtilities
Syntax
public static class HDRenderUtilities
Methods
ComputeCameraSettingsFromProbeSettings(ProbeSettings, ProbeCapturePositionSettings, out CameraSettings, out CameraPositionSettings)
Declaration
public static void ComputeCameraSettingsFromProbeSettings(ProbeSettings settings, ProbeCapturePositionSettings position, out CameraSettings cameraSettings, out CameraPositionSettings cameraPositionSettings)
Parameters
CreatePlanarProbeRenderTarget(Int32)
Declaration
public static RenderTexture CreatePlanarProbeRenderTarget(int planarSize)
Parameters
| Type |
Name |
Description |
| Int32 |
planarSize |
|
Returns
| Type |
Description |
| RenderTexture |
|
CreateReflectionProbeRenderTarget(Int32)
Declaration
public static RenderTexture CreateReflectionProbeRenderTarget(int cubemapSize)
Parameters
| Type |
Name |
Description |
| Int32 |
cubemapSize |
|
Returns
| Type |
Description |
| RenderTexture |
|
CreateReflectionProbeTarget(Int32)
Declaration
public static Cubemap CreateReflectionProbeTarget(int cubemapSize)
Parameters
| Type |
Name |
Description |
| Int32 |
cubemapSize |
|
Returns
GenerateRenderingSettingsFor(ProbeSettings, ProbeCapturePositionSettings, List<CameraSettings>, List<CameraPositionSettings>, Boolean)
Declaration
public static void GenerateRenderingSettingsFor(ProbeSettings settings, ProbeCapturePositionSettings position, List<CameraSettings> cameras, List<CameraPositionSettings> cameraPositions, bool forceFlipY = false)
Parameters
Render(CameraSettings, CameraPositionSettings, Texture, UInt32)
Perform a rendering into target.
Declaration
public static void Render(CameraSettings settings, CameraPositionSettings position, Texture target, uint staticFlags = 0U)
Parameters
| Type |
Name |
Description |
| CameraSettings |
settings |
Settings for the camera.
|
| CameraPositionSettings |
position |
Position for the camera.
|
| Texture |
target |
Target to render to.
|
| UInt32 |
staticFlags |
Only used in the Editor fo cubemaps.
This is bitmask of only objects with these flags will be rendered
|
Examples
How to perform standard rendering:
class StandardRenderingExample
{
public void Render()
{
// Copy default settings
var settings = CameraRenderSettings.Default;
// Adapt default settings to our custom usage
settings.position.position = new Vector3(0, 1, 0);
settings.camera.frustum.fieldOfView = 60.0f;
// Get our render target
var rt = new RenderTexture(128, 128, 1, GraphicsFormat.B8G8R8A8_SNorm);
HDRenderUtilities.Render(settings, rt);
// Do something with rt
rt.Release();
}
}
How to perform a cubemap rendering:
class CubemapRenderExample
{
public void Render()
{
// Copy default settings
var settings = CameraRenderSettings.Default;
// Adapt default settings to our custom usage
settings.position.position = new Vector3(0, 1, 0);
settings.camera.physical.iso = 800.0f;
// Frustum settings are ignored and driven by the cubemap rendering
// Get our render target
var rt = new RenderTexture(128, 128, 1, GraphicsFormat.B8G8R8A8_SNorm)
{
dimension = TextureDimension.Cube
};
// The TextureDimension is detected and the renderer will perform a cubemap rendering.
HDRenderUtilities.Render(settings, rt);
// Do something with rt
rt.Release();
}
}
Render(ProbeSettings, ProbeCapturePositionSettings, Texture, Boolean, Boolean, UInt32)
Declaration
public static void Render(ProbeSettings settings, ProbeCapturePositionSettings position, Texture target, bool forceFlipY = false, bool forceInvertBackfaceCulling = false, uint staticFlags = 0U)
Parameters
Render(ProbeSettings, ProbeCapturePositionSettings, Texture, out CameraSettings, out CameraPositionSettings, Boolean, Boolean, UInt32)
Declaration
public static void Render(ProbeSettings settings, ProbeCapturePositionSettings position, Texture target, out CameraSettings cameraSettings, out CameraPositionSettings cameraPositionSettings, bool forceFlipY = false, bool forceInvertBackfaceCulling = false, uint staticFlags = 0U)
Parameters