m ProbablePrime moved page AudioWaveformTexture (Component) to Component:AudioWaveformTexture: Creating component Namespace |
add info, templates |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=AudioWaveformTextureComponent.png | |Image=AudioWaveformTextureComponent.png | ||
|Name=Audio Waveform Texture | |Name=Audio Waveform Texture | ||
}} | }} | ||
The '''AudioWaveformTexture''' component is used to generate a texture of a line with a visual representation of the volume and pitch of an audio over it's duration. For use with a [[material]]. | |||
<!--T:2--> | <!--T:2--> | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|HighPriorityIntegration|Bool| | |HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}} | ||
|FilterMode|TextureFilterMode| | |FilterMode|TextureFilterMode| {{Template:Texture FilterMode Field}} | ||
|AnisotropicLevel|Int| | |AnisotropicLevel|Int| {{Template:Texture AnisotropicLevel Field}} | ||
|WrapModeU|TextureWrapMode| | |WrapModeU|TextureWrapMode| {{Template:Texture WrapMode Field|X}} | ||
|WrapModeV|TextureWrapMode| | |WrapModeV|TextureWrapMode| {{Template:Texture WrapMode Field|Y}} | ||
|MipmapBias|Float| | |MipmapBias|Float| {{Template:Texture MipmapBias Field}} | ||
|Size|Int2| | |Profile|ColorProfile| {{Template:Texture Profile Field}} | ||
|Mipmaps|Bool| | |Size|Int2| {{Template:ProceduralTexture Size Field}} | ||
|Format|TextureFormat| | |Mipmaps|Bool| {{Template:Texture Mipmaps Field}} | ||
|Clip| | |Format|TextureFormat| {{Template:Texture TextureFormat Field}} | ||
|BackgroundColor| | |Clip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv10=true| The audio clip to pull data from for generating the wave form. | ||
|ForegroundColor| | |BackgroundColor|ColorX| The color behind the waveform. | ||
|ForegroundColor|ColorX| The color of the waveform itself. | |||
}} | |||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|BakeTexture()|[[Type:Action|Action]]| {{Template:BakeTexture Sync Method}} | |||
}} | }} | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
Insert into a [[material]] to view what the texture looks like. | |||
<!--T:4--> | <!--T:4--> | ||
== Examples == | == Examples == | ||
{{stub}} | |||
<!--T:5--> | <!--T:5--> | ||
== | == See Also == | ||
* [[Component:StaticAudioClip]] | |||
* [[Audio Player]] uses this for it's visuals. | |||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Audio Waveform Texture]] | [[Category:Components{{#translation:}}|Audio Waveform Texture]] | ||
[[Category:Components:Assets:Procedural Textures{{#translation:}}|Audio Waveform Texture]] | [[Category:Components:Assets:Procedural Textures{{#translation:}}|Audio Waveform Texture]] | ||
Latest revision as of 16:15, 19 November 2024
Component image 
Audio Waveform Texture component as seen in the Scene Inspector
The AudioWaveformTexture component is used to generate a texture of a line with a visual representation of the volume and pitch of an audio over it's duration. For use with a material.
Fields
| Name | Type | Description |
|---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. |
HighPriorityIntegration
|
Bool | If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes. |
FilterMode
|
TextureFilterMode | How to handle the interpolation between pixels. |
AnisotropicLevel
|
Int | The levels of Anisotropic filtering distances when using Anisotropic for FilterMode
|
WrapModeU
|
TextureWrapMode | How to repeat or mirror the texture along the X axis. this goes into affect when X values are outside of the range [0.0 to 1.0]. |
WrapModeV
|
TextureWrapMode | How to repeat or mirror the texture along the Y axis. this goes into affect when Y values are outside of the range [0.0 to 1.0]. |
MipmapBias
|
Float | Whether to see lower resolution versions of the texture closer up or not (MipMaps). |
Profile
|
ColorProfile | The color profile to use for this texture's rendering. |
Size
|
Int2 | The size of the procedural texture in pixels. |
Mipmaps
|
Bool | Whether to enable the rendering of mipmaps, which are lower res textures at further distances from the camera to improve performance. |
Format
|
TextureFormat | TextureFormat describes how Texture's pixel are stored in the VRAM. |
Clip
|
AudioClip | The audio clip to pull data from for generating the wave form. |
BackgroundColor
|
ColorX | The color behind the waveform. |
ForegroundColor
|
ColorX | The color of the waveform itself. |
Sync Delegates
| Method Name | Method type and Arguments. | Description |
|---|---|---|
BakeTexture()
|
Action | BakeTexture first generates a Component:StaticTexture2D that is the same as this procedural texture. The resulting static texture replaces every reference to the original procedural texture. Lastly the original procedural texture is deleted. |
Usage
Insert into a material to view what the texture looks like.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
See Also
- Component:StaticAudioClip
- Audio Player uses this for it's visuals.