Metadata (Nu)

Metadata Module

Namespace: Nu
Assembly: Nu.dll

Metadata functions.

Functions and values

Function or value	Description
`Metadata.getAnimatedModelMetadata animatedModel` Full Usage: `Metadata.getAnimatedModelMetadata animatedModel` Parameters: animatedModel : `AnimatedModel AssetTag` Returns: `PhysicallyBasedModel`	Forcibly get the metadata of the given animated model (throwing on failure). Thread-safe. animatedModel : `AnimatedModel AssetTag` Returns: `PhysicallyBasedModel`
`Metadata.getMetadataExists assetTag` Full Usage: `Metadata.getMetadataExists assetTag` Parameters: assetTag : `AssetTag` Returns: `bool`	Determine that a given asset's metadata exists. Thread-safe. assetTag : `AssetTag` Returns: `bool`
`Metadata.getMetadataPackagesLoaded ()` Full Usage: `Metadata.getMetadataPackagesLoaded ()` Parameters: () : `unit` Returns: `KeyValuePair<string, KeyValuePair<string, (DateTimeOffset * string * Metadata)>[]> array`	Get the metadate packages that have been loaded. NOTE: this is a potentially expensive call as the tree of ConcurrentDictionaries must be copied to avoid invalidating enumeration in a multi-threaded context. Thread-safe. () : `unit` Returns: `KeyValuePair<string, KeyValuePair<string, (DateTimeOffset * string * Metadata)>[]> array`
`Metadata.getSpineSkeletonMetadata spineSkeleton` Full Usage: `Metadata.getSpineSkeletonMetadata spineSkeleton` Parameters: spineSkeleton : `SpineSkeleton AssetTag` Returns: `SpineSkeletonMetadata`	Forcibly get the metadata of the given Spine skeleton (throwing on failure). Thread-safe. spineSkeleton : `SpineSkeleton AssetTag` Returns: `SpineSkeletonMetadata`
`Metadata.getStaticModelMetadata staticModel` Full Usage: `Metadata.getStaticModelMetadata staticModel` Parameters: staticModel : `StaticModel AssetTag` Returns: `PhysicallyBasedModel`	Forcibly get the metadata of the given static model (throwing on failure). Thread-safe. staticModel : `StaticModel AssetTag` Returns: `PhysicallyBasedModel`
`Metadata.getTextureMetadata image` Full Usage: `Metadata.getTextureMetadata image` Parameters: image : `Image AssetTag` Returns: `TextureMetadata`	Forcibly get the texture metadata of the given image (throwing on failure). Thread-safe. image : `Image AssetTag` Returns: `TextureMetadata`
`Metadata.getTextureSize image` Full Usage: `Metadata.getTextureSize image` Parameters: image : `Image AssetTag` Returns: `Vector2i`	Forcibly get the texture size of the given image (throwing on failure). Thread-safe. image : `Image AssetTag` Returns: `Vector2i`
`Metadata.getTextureSizeF image` Full Usage: `Metadata.getTextureSizeF image` Parameters: image : `Image AssetTag` Returns: `Vector2`	Forcibly get the texture size of the given image (throwing on failure). Thread-safe. image : `Image AssetTag` Returns: `Vector2`
`Metadata.getTileMapMetadata tileMap` Full Usage: `Metadata.getTileMapMetadata tileMap` Parameters: tileMap : `TileMap AssetTag` Returns: `TileMapMetadata`	Forcibly get the metadata of the given tile map (throwing on failure). Thread-safe. tileMap : `TileMap AssetTag` Returns: `TileMapMetadata`
`Metadata.init assetGraph` Full Usage: `Metadata.init assetGraph` Parameters: assetGraph : `AssetGraph`	Initialize metadata to use the given imperative value and asset graph. assetGraph : `AssetGraph`
`Metadata.loadMetadataPackage packageName` Full Usage: `Metadata.loadMetadataPackage packageName` Parameters: packageName : `string`	Attempt to load the given metadata package. Thread-safe. packageName : `string`
`Metadata.reloadMetadata ()` Full Usage: `Metadata.reloadMetadata ()` Parameters: () : `unit`	Reload metadata. Thread-safe. () : `unit`
`Metadata.tryGetAnimatedModelAlbedoImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelAlbedoImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the albedo image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelAmbientOcclusionImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelAmbientOcclusionImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the ambient occlusion image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelEmissionImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelEmissionImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the emission image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelFinenessImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelFinenessImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the fineness image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelHeightImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelHeightImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the height image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelMetadata animatedModel` Full Usage: `Metadata.tryGetAnimatedModelMetadata animatedModel` Parameters: animatedModel : `AnimatedModel AssetTag` Returns: `PhysicallyBasedModel voption`	Attempt to get the metadata of the given animated model. Thread-safe. animatedModel : `AnimatedModel AssetTag` Returns: `PhysicallyBasedModel voption`
`Metadata.tryGetAnimatedModelMetallicImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelMetallicImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the metallic image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelNavShape materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelNavShape materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `NavShape voption`	Attempt to get the 3d navigation shape property for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `NavShape voption`
`Metadata.tryGetAnimatedModelNormalImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelNormalImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the normal image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelRoughnessImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelRoughnessImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the roughness image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelScatterImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelScatterImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the scatter image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelSubdermalImage materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelSubdermalImage materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the subdermal image asset for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetAnimatedModelTwoSided materialIndex animatedModel` Full Usage: `Metadata.tryGetAnimatedModelTwoSided materialIndex animatedModel` Parameters: materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `bool voption`	Attempt to get the two-sided property for the given material index and animated model. Thread-safe. materialIndex : `int` animatedModel : `AnimatedModel AssetTag` Returns: `bool voption`
`Metadata.tryGetFilePath assetTag` Full Usage: `Metadata.tryGetFilePath assetTag` Parameters: assetTag : `AssetTag` Returns: `string option`	Attempt to get the file path of the given asset. Thread-safe. assetTag : `AssetTag` Returns: `string option`
`Metadata.tryGetMetadata assetTag` Full Usage: `Metadata.tryGetMetadata assetTag` Parameters: assetTag : `AssetTag` Returns: `Metadata voption`	Attempt to get the metadata of the given asset. Thread-safe. assetTag : `AssetTag` Returns: `Metadata voption`
`Metadata.tryGetSpineSkeletonMetadata spineSkeleton` Full Usage: `Metadata.tryGetSpineSkeletonMetadata spineSkeleton` Parameters: spineSkeleton : `SpineSkeleton AssetTag` Returns: `SpineSkeletonMetadata voption`	Attempt to get the metadata of the given Spine skeleton. Thread-safe. spineSkeleton : `SpineSkeleton AssetTag` Returns: `SpineSkeletonMetadata voption`
`Metadata.tryGetStaticModelAlbedoImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelAlbedoImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the albedo image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelAmbientOcclusionImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelAmbientOcclusionImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the ambient occlusion image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelClipped materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelClipped materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `bool voption`	Attempt to get the clipped property for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `bool voption`
`Metadata.tryGetStaticModelEmissionImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelEmissionImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the emission image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelFinenessImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelFinenessImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the fineness image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelHeightImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelHeightImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the height image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelMetadata staticModel` Full Usage: `Metadata.tryGetStaticModelMetadata staticModel` Parameters: staticModel : `StaticModel AssetTag` Returns: `PhysicallyBasedModel voption`	Attempt to get the metadata of the given static model. Thread-safe. staticModel : `StaticModel AssetTag` Returns: `PhysicallyBasedModel voption`
`Metadata.tryGetStaticModelMetallicImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelMetallicImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the metallic image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelNavShape materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelNavShape materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `NavShape voption`	Attempt to get the 3d navigation shape for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `NavShape voption`
`Metadata.tryGetStaticModelNormalImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelNormalImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the normal image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelRoughnessImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelRoughnessImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the roughness image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelScatterImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelScatterImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the scatter image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelSubdermalImage materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelSubdermalImage materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`	Attempt to get the subsurface image asset for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `'a AssetTag voption`
`Metadata.tryGetStaticModelTwoSided materialIndex staticModel` Full Usage: `Metadata.tryGetStaticModelTwoSided materialIndex staticModel` Parameters: materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `bool voption`	Attempt to get the two-sided property for the given material index and static model. Thread-safe. materialIndex : `int` staticModel : `StaticModel AssetTag` Returns: `bool voption`
`Metadata.tryGetTextureMetadata image` Full Usage: `Metadata.tryGetTextureMetadata image` Parameters: image : `Image AssetTag` Returns: `TextureMetadata voption`	Attempt to get the texture metadata of the given image. Thread-safe. image : `Image AssetTag` Returns: `TextureMetadata voption`
`Metadata.tryGetTextureSize image` Full Usage: `Metadata.tryGetTextureSize image` Parameters: image : `Image AssetTag` Returns: `Vector2i voption`	Attempt to get the texture size of the given image. Thread-safe. image : `Image AssetTag` Returns: `Vector2i voption`
`Metadata.tryGetTextureSizeF image` Full Usage: `Metadata.tryGetTextureSizeF image` Parameters: image : `Image AssetTag` Returns: `Vector2 voption`	Attempt to get the texture size of the given image. Thread-safe. image : `Image AssetTag` Returns: `Vector2 voption`
`Metadata.tryGetTileMapMetadata tileMap` Full Usage: `Metadata.tryGetTileMapMetadata tileMap` Parameters: tileMap : `TileMap AssetTag` Returns: `TileMapMetadata voption`	Attempt to get the metadata of the given tile map. Thread-safe. tileMap : `TileMap AssetTag` Returns: `TileMapMetadata voption`
`Metadata.unloadMetadataPackage packageName` Full Usage: `Metadata.unloadMetadataPackage packageName` Parameters: packageName : `string` Returns: `bool * ConcurrentDictionary<string, (DateTimeOffset * string * Metadata)>`	Attempt to unload the given metadata package. Thread-safe. packageName : `string` Returns: `bool * ConcurrentDictionary<string, (DateTimeOffset * string * Metadata)>`