Decalery manual - Revision history

Mr F: /* DecalSpawner */

2025-11-01T22:01:00Z

‎DecalSpawner

Mr F: /* DecalSpawner */

2025-11-01T22:00:10Z

‎DecalSpawner

Mr F: /* DecalUtils */

2025-11-01T21:58:51Z

‎DecalUtils

Mr F: /* DecalSpawner */

2025-11-01T21:56:48Z

‎DecalSpawner

Mr F: /* DecalSpawner */

2025-11-01T21:56:19Z

‎DecalSpawner

Mr F: /* DecalSpawner */

2025-11-01T21:51:32Z

‎DecalSpawner

Mr F: /* DecalSpawner */

2025-11-01T21:50:55Z

‎DecalSpawner

Mr F: /* Menu */

2025-11-01T21:39:39Z

‎Menu

Mr F: /* Decal Global Runtime Settings */

2025-11-01T21:37:33Z

‎Decal Global Runtime Settings

Mr F: /* Editor Decal Components */

2025-11-01T21:11:55Z

‎Editor Decal Components

@@ Line 411: / Line 411: @@
 {{note|Currently, skinned meshes only support CPU generation mode. DecalSpawner will automatically fallback to CPU when used on skinned meshes.}}<br>
-*'''{{code|<nowiki>DecalUtils.Handle AddDecal(Vector3 position, Quaternion rotation, GameObject hitObject, float decalSizeX, float decalSizeY, float distance, float opacity, float angleClip, Transform rootObject, int texArraySlice = -1, float atlasMinX = 0, float atlasMinY = 0, float atlasMaxX = 1, float atlasMaxY = 1, bool objAsRoot = false)</nowiki>}}'''Spawns a decal on ''hitObject'' from a projector placed at ''position'' in the direction of ''rotation''.<br>
+*'''{{code|<nowiki>DecalUtils.Handle AddDecal(Vector3 position, Quaternion rotation, GameObject hitObject, float decalSizeX, float decalSizeY, float distance, float opacity, float angleClip, Transform rootObject, int texArraySlice = -1, float atlasMinX = 0, float atlasMinY = 0, float atlasMaxX = 1, float atlasMaxY = 1, bool objAsRoot = false)</nowiki>}}'''Spawns a decal on ''hitObject'' from a projector placed at ''position'' in the direction of ''rotation''.<br>Return value is a Handle that can be used in DecalUtils.RemoveDecal().<br>
 ** '''{{code|<nowiki>Vector3 position</nowiki>}}'''Projection origin.<br>
 ** '''{{code|<nowiki>Quaternion rotation</nowiki>}}'''Projection rotation. Decals are projected along the positive Z axis.<br>
@@ Line 424: / Line 424: @@
 ** '''{{code|<nowiki>float atlasMinX, atlasMinY, atlasMaxX, atlasMaxY</nowiki>}}'''Optional UV transformation.<br>
 ** '''{{code|<nowiki>bool objAsRoot</nowiki>}}'''Option to treat every receiving Renderer as rootObject (If hitObject has a DecalMeshRef component, one AddDecal call may end up applying multiple decals to different sub-receivers).<br>
 <br>

@@ Line 411: / Line 411: @@
 {{note|Currently, skinned meshes only support CPU generation mode. DecalSpawner will automatically fallback to CPU when used on skinned meshes.}}<br>
-*'''{{code|<nowiki>void AddDecal(Vector3 position, Quaternion rotation, GameObject hitObject, float decalSizeX, float decalSizeY, float distance, float opacity, float angleClip, Transform rootObject, int texArraySlice = -1, float atlasMinX = 0, float atlasMinY = 0, float atlasMaxX = 1, float atlasMaxY = 1, bool objAsRoot = false)</nowiki>}}'''Spawns a decal on ''hitObject'' from a projector placed at ''position'' in the direction of ''rotation''.<br>
+*'''{{code|<nowiki>DecalUtils.Handle AddDecal(Vector3 position, Quaternion rotation, GameObject hitObject, float decalSizeX, float decalSizeY, float distance, float opacity, float angleClip, Transform rootObject, int texArraySlice = -1, float atlasMinX = 0, float atlasMinY = 0, float atlasMaxX = 1, float atlasMaxY = 1, bool objAsRoot = false)</nowiki>}}'''Spawns a decal on ''hitObject'' from a projector placed at ''position'' in the direction of ''rotation''.<br>
 ** '''{{code|<nowiki>Vector3 position</nowiki>}}'''Projection origin.<br>
 ** '''{{code|<nowiki>Quaternion rotation</nowiki>}}'''Projection rotation. Decals are projected along the positive Z axis.<br>
@@ Line 424: / Line 424: @@
 ** '''{{code|<nowiki>float atlasMinX, atlasMinY, atlasMaxX, atlasMaxY</nowiki>}}'''Optional UV transformation.<br>
 ** '''{{code|<nowiki>bool objAsRoot</nowiki>}}'''Option to treat every receiving Renderer as rootObject (If hitObject has a DecalMeshRef component, one AddDecal call may end up applying multiple decals to different sub-receivers).<br>
 <br>

@@ Line 455: / Line 455: @@
 === DecalUtils ===
 DecalUtils.Group is a lower-level object, representing a fixed-sized pool of decals, sharing a common material, lightmap index and parent transform. Most of the time there is no need to use it directly. ''DecalUtils'' class uses static methods to work with ''DecalUtils.Group''. Underneath, most methods branch to either ''CPUDecalUtils'', ''CPUBurstDecalUtils'' or ''GPUDecalUtils''.
 <hr>

@@ Line 434: / Line 434: @@
 *'''{{code|<nowiki>void Release()</nowiki>}}'''Removes all visible decals, created with this spawner and releases all used memory.<br><br>
-*'''{{code|<nowiki>void ClearDecalsForRootTransform(Transform rootTransform)</nowiki>}}'''removes all decals created by this spawner applied to rootTransform.<br><br>
+*'''{{code|<nowiki>void ClearDecalsForRootTransform(Transform rootTransform)</nowiki>}}'''Removes all decals created by this spawner applied to rootTransform.<br><br>
 Static properties:

← Older revision		Revision as of 21:56, 1 November 2025
Line 433:		Line 433:

	*'''{{code\|<nowiki>void Release()</nowiki>}}'''Removes all visible decals, created with this spawner and releases all used memory.<br><br>		*'''{{code\|<nowiki>void Release()</nowiki>}}'''Removes all visible decals, created with this spawner and releases all used memory.<br><br>
		+
		+	*'''{{code\|<nowiki>void ClearDecalsForRootTransform(Transform rootTransform)</nowiki>}}'''removes all decals created by this spawner applied to rootTransform.<br><br>

	Static properties:		Static properties:

@@ Line 421: / Line 421: @@
 ** '''{{code|<nowiki>float angleClip</nowiki>}}'''Same as ''Angle clip'' in [[Decalery_manual#DecalGroup|DecalGroup]].<br>
 ** '''{{code|<nowiki>Transform rootObject</nowiki>}}'''Optional transform used as a parent for this decal. Assign movable objects' transforms here.<br>
-** '''{{code|<nowiki>int texArraySlice</nowiki>}}'''Optional texture array slice to be stored into vertices.<br>
+** '''{{code|<nowiki>int texArraySlice</nowiki>}}'''Optional texture array slice to be stored in vertices.<br>
 ** '''{{code|<nowiki>float atlasMinX, atlasMinY, atlasMaxX, atlasMaxY</nowiki>}}'''Optional UV transformation.<br>
 ** '''{{code|<nowiki>bool objAsRoot</nowiki>}}'''Option to treat every receiving Renderer as rootObject (If hitObject has a DecalMeshRef component, one AddDecal call may end up applying multiple decals to different sub-receivers).<br>

@@ Line 372: / Line 372: @@
 ** Do not combine to more vertices than the "Limit vertices per batch" value.
 * '''Decalery -> Select decal source''': if the final decal mesh is selected, will change selection to its source object (the one with the Decal Group).
 == Runtime API ==

@@ Line 319: / Line 319: @@
 ** '''GPU With Readback''': computes final decal mesh fully on the GPU, reads the result to RAM and stores into mesh.
 ** '''Full GPU''': computes final decal mesh fully on the GPU and draws it directly from computed buffers without any RAM readbacks.
+* Async Readback: when using "GPU With Readback" mode, performs an asynchronous read instead of stalling.
 {{note| There are different limitations to each technique.

@@ Line 295: / Line 295: @@
 ** Average From Receivers: sets one average normal for the whole decal;
 ** Project From Receivers: uses rays to pick receiver normals at each source mesh vertex and then interpolates the results over the final decal mesh.
-* Optimize topology (experimental): runs complex geometry optimization to reduce number of vertices and triangles. Doesn't show in Live Preview (only on Update). Needs Weld Vertices, currently doesn't work with Burst and on non-Windows editors.
+* Optimize topology (experimental): runs complex geometry optimization to reduce the number of vertices and triangles. Doesn't show in Live Preview (only on Update). Needs Weld Vertices, currently doesn't work with Burst and on non-Windows editors.
 * Use Texture Arrays: allows setting texture array slice value for the decal. Values are encoded into decal vertices and used by compatible shaders. Different decals using different slices can later be batched/combined in one.
 ** Texture Array Slice: number of the slice to use.