Skip to main content

manage_graphics

Auto-generated from the Python tool registry. Do not hand-edit outside <!-- examples:start --><!-- examples:end --> blocks — the generator (tools/generate_docs_reference.py) will overwrite them.

Group: core  ·  Module: services.tools.manage_graphics

Description

Manage rendering graphics: volumes, post-processing, light baking, rendering stats, pipeline settings, and URP renderer features. Use ping to check pipeline and available features.

VOLUME (require URP/HDRP):

  • volume_create, volume_add_effect, volume_set_effect, volume_remove_effect
  • volume_get_info, volume_set_properties, volume_list_effects, volume_create_profile

BAKE (Edit mode only):

  • bake_start, bake_cancel, bake_status, bake_clear, bake_reflection_probe
  • bake_get_settings, bake_set_settings
  • bake_create_light_probe_group, bake_create_reflection_probe, bake_set_probe_positions

STATS:

  • stats_get: Rendering counters (draw calls, batches, triangles, etc.)
  • stats_list_counters, stats_set_scene_debug, stats_get_memory

PIPELINE:

  • pipeline_get_info, pipeline_set_quality, pipeline_get_settings, pipeline_set_settings

FEATURES (URP only):

  • feature_list, feature_add, feature_remove, feature_configure, feature_toggle, feature_reorder

SKYBOX / ENVIRONMENT:

  • skybox_get: Read all environment settings (material, ambient, fog, reflection, sun)
  • skybox_set_material: Set skybox material by asset path
  • skybox_set_properties: Set properties on current skybox material (tint, exposure, rotation)
  • skybox_set_ambient: Set ambient lighting mode and colors
  • skybox_set_fog: Enable/configure fog (mode, color, density, start/end distance)
  • skybox_set_reflection: Set environment reflection settings
  • skybox_set_sun: Set the sun source light

Parameters

NameTypeRequiredDescription
actionstryesThe graphics action to perform.
targetstr | NoneTarget object name or instance ID.
effectstr | NoneEffect type name (e.g., 'Bloom', 'Vignette').
parametersdict[str, Any] | NoneDict of parameter values.
propertiesdict[str, Any] | NoneDict of properties to set.
settingsdict[str, Any] | NoneDict of settings (bake/pipeline).
namestr | NoneName for created objects.
is_globalbool | NoneWhether Volume is global (default true).
weightfloat | NoneVolume weight (0-1).
priorityfloat | NoneVolume priority.
profile_pathstr | NoneAsset path for VolumeProfile.
effectslist[dict[str, Any]] | NoneEffect definitions for volume_create.
pathstr | NoneAsset path for volume_create_profile.
levelstr | NoneQuality level name or index.
positionlist[float] | NonePosition [x,y,z].
grid_sizelist[int] | NoneProbe grid size [x,y,z].
spacingfloat | NoneProbe grid spacing.
sizelist[float] | NoneProbe/volume size [x,y,z].
resolutionint | NoneProbe resolution.
modestr | NoneProbe mode or debug mode.
hdrbool | NoneHDR for reflection probes.
box_projectionbool | NoneBox projection for reflection probes.
positionslist[list[float]] | NoneProbe positions array.
indexint | NoneFeature index.
activebool | NoneFeature active state.
orderlist[int] | NoneFeature reorder indices.
async_bakebool | NoneAsync bake (default true).
feature_typestr | NoneRenderer feature type name.
materialstr | NoneMaterial asset path for feature.
colorlist[float] | NoneColor [r,g,b,a] for ambient/fog.
intensityfloat | NoneIntensity value (ambient/reflection).
ambient_modestr | NoneAmbient mode: Skybox, Trilight, Flat, Custom.
equator_colorlist[float] | NoneEquator color [r,g,b,a] (Trilight mode).
ground_colorlist[float] | NoneGround color [r,g,b,a] (Trilight mode).
fog_enabledbool | NoneEnable or disable fog.
fog_modestr | NoneFog mode: Linear, Exponential, ExponentialSquared.
fog_colorlist[float] | NoneFog color [r,g,b,a].
fog_densityfloat | NoneFog density (Exponential modes).
fog_startfloat | NoneFog start distance (Linear mode).
fog_endfloat | NoneFog end distance (Linear mode).
bouncesint | NoneReflection bounces.
reflection_modestr | NoneDefault reflection mode: Skybox, Custom.

Returns

A dict containing the Unity response. The exact shape depends on the action.

Examples

No examples yet. Add usage examples here — they will be preserved across regenerations.