Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Bitmap Asset Metadata | |Name=Bitmap Asset Metadata | ||
}} | }} | ||
The '''BitmapAssetMetadata''' component is used to get pixel data information on a given image or texture. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Asset|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv0=true| | |Asset|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv0=true| The image to get data from. | ||
|Width|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv1=true| | |Width|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv1=true| The width of <code>Asset</code>. | ||
|Height|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv2=true| | |Height|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv2=true| The height of <code>Asset</code>. | ||
|BaseFormat|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| | |BaseFormat|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| The format of <code>Asset</code>. | ||
|ColorData|{{RootFieldType|RawOutput`1|[[Type:ColorChannelData|ColorChannelData]]}}|TypeAdv4=true| | |ColorData|{{RootFieldType|RawOutput`1|[[Type:ColorChannelData|ColorChannelData]]}}|TypeAdv4=true| The ColorChannelData for <code>Asset</code> | ||
|AlphaData|{{RootFieldType|RawOutput`1|[[Type:AlphaChannelData|AlphaChannelData]]}}|TypeAdv5=true| | |AlphaData|{{RootFieldType|RawOutput`1|[[Type:AlphaChannelData|AlphaChannelData]]}}|TypeAdv5=true| The AlphaChannelData for <code>Asset</code>. | ||
|BitsPerPixel|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv6=true| | |BitsPerPixel|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv6=true| How many bits are used per pixel to store color data in <code>Asset</code>. | ||
|ChannelCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv7=true| | |ChannelCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv7=true| How many channels <code>Asset</code> has (RGBA for example is 4, but some images may have more or less.) | ||
|AverageColor|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv8=true| | |AverageColor|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv8=true| <code>Asset</code>'s average color, visible or not. | ||
|AverageVisibleColor|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv9=true| | |AverageVisibleColor|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv9=true| <code>Asset</coRoo's average visible color. | ||
|AverageHSV|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv10=true| | |AverageHSV|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv10=true| <code>Asset</code>'s average HSV color, visible ot not. | ||
|AverageVisibleHSV|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv11=true| | |AverageVisibleHSV|{{RootFieldType|RawOutput`1|[[Type:ColorX|ColorX]]}}|TypeAdv11=true| <code>Asset</code>'s average visible HSV color. | ||
|InvalidPixelCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv12=true| | |InvalidPixelCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv12=true| how many pixels in <code>Asset</code> that have NAN values in their color values. | ||
}} | }} | ||
== | == Usage == | ||
{{stub}} | |||
== Examples == | == Examples == | ||
| Line 30: | Line 31: | ||
[[Category:Components:Assets:Metadata{{#translation:}}|Bitmap Asset Metadata]] | [[Category:Components:Assets:Metadata{{#translation:}}|Bitmap Asset Metadata]] | ||
[[Category:Components{{#translation:}}|Bitmap Asset Metadata]] | [[Category:Components{{#translation:}}|Bitmap Asset Metadata]] | ||
Revision as of 23:35, 1 January 2025
Component image 
Bitmap Asset Metadata component as seen in the Scene Inspector
The BitmapAssetMetadata component is used to get pixel data information on a given image or texture.
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. |
Asset
|
Texture2D | The image to get data from. |
Width
|
raw output of Int | The width of Asset.
|
Height
|
raw output of Int | The height of Asset.
|
BaseFormat
|
raw output of String | The format of Asset.
|
ColorData
|
raw output of ColorChannelData | The ColorChannelData for Asset
|
AlphaData
|
raw output of AlphaChannelData | The AlphaChannelData for Asset.
|
BitsPerPixel
|
raw output of Double | How many bits are used per pixel to store color data in Asset.
|
ChannelCount
|
raw output of Int | How many channels Asset has (RGBA for example is 4, but some images may have more or less.)
|
AverageColor
|
raw output of ColorX | Asset's average color, visible or not.
|
AverageVisibleColor
|
raw output of ColorX | Asset</coRoo's average visible color.
|
AverageHSV
|
raw output of ColorX | Asset's average HSV color, visible ot not.
|
AverageVisibleHSV
|
raw output of ColorX | Asset's average visible HSV color.
|
InvalidPixelCount
|
raw output of Int | how many pixels in Asset that have NAN values in their color values.
|
Usage
This article or section is a Stub. You can help the Resonite Wiki by expanding it.