rendering kit

47 tools. Generated from the plugin source; do not edit by hand.

Guide

rendering.configure_* tools read one persisted renderer feature when value is empty and write its documented Unreal value when present. They cover virtual textures, skin cache, ray tracing, Nanite, Lumen GI/reflections, shadow maps, default AA, Mobile HDR, forward shading, DBuffers, and GPU scene. Each writes project config, can require restart/shaders, and is Risk 4.

The rendering kit manages two things that need a persistent, renderer-specific contract: TextureRenderTarget2D assets and project-wide defaults in URendererSettings. It also audits those assets/defaults. Enable it with edit.enable_kits when the session uses adaptive exposure.

Start here

1. Create a target with rendering.create_render_target in a /Game folder.
2. Inspect it with rendering.get_render_target and use rendering.audit_render_target before wiring it into a scene capture, material, or widget.
3. Resize, select storage format, enable mips, or change the clear color with the target tools.
4. Use rendering.get_project_features before changing Forward Shading, mobile post-processing (r.MobileHDR), or virtual textures.
5. Use rendering.get_default_post_process to inspect project defaults such as bloom and exposure bias.
6. Make a deliberate config change with one of the two setters, then restart/recompile as reported by the editor.
7. Finish with rendering.audit_project_renderer to record the persisted state and compatibility warnings.

Target assets

create_render_target accepts portable format names: r8, rg8, rgba8, rgba8_srgb, r16f, rg16f, rgba16f, r32f, rg32f, rgba32f, and rgb10a2. list_render_target_formats returns the same list. The target reply includes an uncompressed base-level estimate; mipmaps and RHI resource overhead are additional.

Use rgba8 for ordinary UI or mask buffers. Use rgba16f for HDR scene data unless a workflow needs 32-bit float precision. audit_render_target explicitly warns about large targets, mip cost, and rgba32f.

The kit only creates and changes assets. Configure a SceneCaptureComponent2D, bind a target to a component, or use its output in a material through the existing component.* and material.* tools.

Persistent project defaults

set_project_features writes only bForwardShading, bMobilePostProcessing (the persisted r.MobileHDR setting), and bVirtualTextures. set_default_post_process writes only renderer default features: bloom, ambient occlusion, motion blur, lens flare, and auto-exposure bias. Pass each edit as a settings key/value array, for example:

{
  "settings": [
    {"key": "bDefaultFeatureBloom", "value": "false"},
    {"key": "DefaultFeatureAutoExposureBias", "value": "1.0"}
  ]
}

Both setters update DefaultEngine.ini, may require an editor restart, and can cause shader work. They do not alter the current session's CVars. Use render.* in the edit kit for session/scalability changes.

Boundaries

Use level.* for post-process volumes and their overrides, component.* for post-process and scene-capture components, material.* for post-process materials, and mesh.* for Nanite mesh settings. This separation prevents a renderer-default request from accidentally changing a level asset or a current-editor CVar.

Gotchas

• Target folder paths must start with /Game; asset names are bare names, not paths.
• Width and height are constrained to 1..16384 before an engine API is called.
• clear_render_target clears the live resource to the stored clear color; it does not modify asset data.
• A missing renderer property becomes a warning on the supported engine version. Do not infer that a missing setting was applied.
• Validation is pending the deferred UE 4.27 and UE 5.8 build/smoke cycle.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

rendering.audit_project_renderer (risk 0, smoke)

Audits project renderer defaults without changing CVars, scalability, mesh settings, components, or volumes.

No arguments.

Returns: settings, warnings, forwardShading, virtualTextures.

rendering.audit_render_target (risk 0, smoke)

Audits a render target's dimensions, format, mip state and estimated base-level memory.

Argument	Type	Description
target	string	required. Render target asset path.

Returns: target, valid, warnings.

rendering.clear_render_target (risk 2, mutates, smoke)

Clears a target resource to its configured clear color without changing its asset data.

Argument	Type	Description
target	string	required. Render target asset path.

Returns: target, message.

rendering.configure_dbuffers (risk 4, mutates)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_default_anti_aliasing (risk 4, mutates)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_forward_shading (risk 4, mutates)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_gpu_scene (risk 4, mutates)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_lumen_gi (risk 4, mutates, UE 5.0+)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_lumen_reflections (risk 4, mutates, UE 5.0+)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_mobile_hdr (risk 4, mutates)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_nanite (risk 4, mutates, UE 5.0+)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_ray_tracing (risk 4, mutates, UE 5.0+)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_shadow_maps (risk 4, mutates, UE 5.0+)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_skin_cache (risk 4, mutates)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.configure_virtual_textures (risk 4, mutates)

No description.

Argument	Type	Description
value	string	Unreal text for this tool's one documented renderer property; empty only reads it.

Returns: settings, warnings, restartRequired.

rendering.create_render_target (risk 2, mutates, smoke)

Creates a persistent TextureRenderTarget2D asset.

Argument	Type	Description
folder	string	required. Content folder under /Game.
name	string	required. Bare asset name.
width	integer	Width in pixels, 1 through 16384. Default 1024.
height	integer	Height in pixels, 1 through 16384. Default 1024.
format	string	r8, rg8, rgba8, rgba8_srgb, r16f, rg16f, rgba16f, r32f, rg32f, rgba32f, or rgb10a2. Default TEXT("rgba8").
clearColor	string	Clear color as r,g,b,a in 0..1. Default TEXT("0,0,0,1").
generateMips	boolean	Generate mipmaps for this target. Default false.

Returns: target, message.

rendering.get_default_ambient_occlusion (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_default_auto_exposure (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_default_bloom (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_default_lens_flare (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_default_motion_blur (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_default_post_process (risk 0, smoke)

Returns the project-wide post-process defaults used when a volume or camera does not override them.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_dxt5_normal_maps (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_gpu_morph_targets (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_local_fog_support (risk 0, UE 5.0+, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_project_features (risk 0, smoke)

Returns project-wide Forward, Mobile HDR and virtual-texture feature defaults.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_render_target (risk 0, smoke)

Returns dimensions, format, mip state and estimated memory for a render target.

Argument	Type	Description
target	string	required. Render target asset path.

Returns: target, message.

rendering.get_sky_atmosphere_support (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.get_static_lighting_normal_maps (risk 0, smoke)

No description.

No arguments.

Returns: settings, warnings, restartRequired.

rendering.list_render_target_formats (risk 0, smoke)

Lists the portable render-target format identifiers understood by this kit.

No arguments.

Returns: formats.

rendering.list_render_targets (risk 0, smoke)

Lists TextureRenderTarget2D assets without inspecting material or component bindings.

Argument	Type	Description
folder	string	Content folder under /Game. Empty lists all render targets.
nameContains	string	Optional case-insensitive asset-name substring.
recursive	boolean	Include descendant folders. Default true.

Returns: targets, count.

rendering.resize_render_target (risk 2, mutates, smoke)

Resizes a render target while retaining its format and clear color.

Argument	Type	Description
target	string	required. Render target asset path.
width	integer	required. New width in pixels, 1 through 16384.
height	integer	required. New height in pixels, 1 through 16384.

Returns: target, message.

rendering.set_default_ambient_occlusion (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_default_auto_exposure (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_default_bloom (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_default_lens_flare (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_default_motion_blur (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_default_post_process (risk 4, mutates)

Persists project-wide post-process defaults; it never edits a volume, camera, component, or post-process material.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Default-feature assignments: bDefaultFeatureBloom, bDefaultFeatureAmbientOcclusion, bDefaultFeatureMotionBlur, bDefaultFeatureLensFlare, DefaultFeatureAutoExposureBias.

Returns: settings, warnings, restartRequired.

rendering.set_dxt5_normal_maps (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_gpu_morph_targets (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_local_fog_support (risk 4, mutates, UE 5.0+)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_project_features (risk 4, mutates)

Persists project-wide Forward, Mobile HDR and virtual-texture feature defaults; an editor restart and shader rebuild can be required.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_render_target_clear_color (risk 2, mutates, smoke)

Changes a render target's configured clear color without clearing it immediately.

Argument	Type	Description
target	string	required. Render target asset path.
clearColor	string	required. New clear color as r,g,b,a in 0..1.

Returns: target, message.

rendering.set_render_target_format (risk 2, mutates, smoke)

Changes the storage format of a render target and recreates its resource.

Argument	Type	Description
target	string	required. Render target asset path.
format	string	required. r8, rg8, rgba8, rgba8_srgb, r16f, rg16f, rgba16f, r32f, rg32f, rgba32f, or rgb10a2.
forceLinearGamma	boolean	Force linear gamma. Default false.

Returns: target, message.

rendering.set_render_target_mips (risk 2, mutates, smoke)

Enables or disables render-target mip generation.

Argument	Type	Description
target	string	required. Render target asset path.
generateMips	boolean	Generate mipmaps. Default false.

Returns: target, message.

rendering.set_sky_atmosphere_support (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.

rendering.set_static_lighting_normal_maps (risk 4, mutates)

No description.

Argument	Type	Description
settings	array of UeaRenderingKeyValue	required. Project renderer feature assignments: bForwardShading, bMobilePostProcessing, bVirtualTextures.

Returns: settings, warnings, restartRequired.