Generate Asset Library

Asset Library

An asset library is a binary compact format containing all user defined artifacts part of a solution.

Open "Generate Asset Library" dialog via menu or toolbar item.

The "Generate Asset Library" dialog lists following items part of the solution for asset generation:

• All items having the property "Export Always" enabled. 
  
• All items which are referred by exported items. 
  

 

Dialog UI

1 Uddate button When you change the settings of a profile selected in the profile list, press this button to save the changes. If you do not press this button, the changes will not be saved to the target profile. 2 Add button

Creates a new asset profile. Clicking the button displays the [Add New Asset Profile] dialog. The "created profile will be displayed in the profile list in the [Generate Asset Library"Library] dialogdialog. isIt structuredwill asalso be added to the Solution Explorer.

3 Delete button Select a tree, for easier selection of multiple itemsprofile from the sameprofile folder/module.list Whenand click this button to delete it. 4 Profile search field Enter a userstring checksin this field to search for the corresponding profile in the profile list. 5 Profile list  Asset profiles are listed. 6 Item search field  Enter a string in this field to search for the corresponding profile in the item list. 7 Item List

The items to be output as assets are listed in a tree structure.
Items with a check mark in the checkbox will be excluded from the asset library generation. However, if other items in the asset require them, the checked items will not be excluded.
Also, if a folder foris excluding,checked, all the items fromin thethat folder whichthat can be excluded will also be checked. If you right-click while a folder is selected, you can use the [ Select/Expand All/
Collapse All ] options.

In

the upperpart8 of the "Generate Asset Library"Location dialog two search boxes are available, for easier identification of any desired item in the Profile list or in the Excluded Items list.

---

Saving Asset Profile

On the left side, the Current Asset Profile can be seen. If needed, it is possible to create and save different asset profiles. First the new asset profile has to be created by using the "Add" button. After associating the new asset profile with a specific name, these options should be configured:

Exclude Item: The checkbox in the "Exclude Item" list allows to explicitly exclude items from asset generation. Although, checked items will not be excluded if other items of the asset require them. 
Asset File: Specify the location ofwhere the generated asset filefiles beingwill generated.be
saved. You can specify the location by clicking the [Browse] button. 9 Environment: Select either "Simulation"Simulation or "Target".Target. Note that all shaders used in the solution asand well asany additional shaders with the property "“Export Always"Always” property enabled will be added to the asset file.
10 Stride Alignment

Set the stride alignment when generating assets. This is disabled by default.

The term “stride” refers to the number of bytes between the start of one line of pixel data in memory and the start of the next line. The stride is specified using the Type and Size settings.

Type: Select from Pixel or Byte FloatSize: NumberSelect Format:from The1, Float2, Number4, Format8, 16, 32, 64, 128, or 256 bytes

Example settings)

If the Type is Pixel and the Size is 8, the bitmap data will show,be dependingaligned onto the platformpixel used,type and set to a multiple of 8 bytes. If the Type is Byte and the Size is 32, the bitmap data will be aligned to the byte type and set to a multiple of numbers32 generatedbytes. in 11 Asett ID  Specify the Assetasset Library.ID.
12 Display asset report: Shows

Display a report containing the serialized items after asset generation. SeeFor moredetails, infosee here.

13 Run script

Executes the specified script after the asset is generated. For details, see here.

Run script:Execute14 Generate button Pressing this button executes the given script after asset generation. See more info here. 

The options "Select, Expand All and Collapse All" are available for every item right clicked inside "Scene Tree" sidegeneration of the view.

asset library.

From

all 15 Close button Close Button Pressing this button closes the itemsdialog. available, if necessary, some of them can be excluded by clicking on the checkboxes from the "Exclude Item" list.

AfterWhile allScene these settings are done, the "Update" button should be used. This operation can be done for every different generation. In this way, every new created asset profiles can be saved.

The following fields will be saved in the asset profile: "Environment", "Float Number Format", "Asset ID", "Display asset report" and "Run script". The value of the "Asset Location" will also be saved when saving an asset profile.

If a modificationComposer is done in a current asset profile, the "Update" button should be used again to save the changes. 
The "Delete" button should be used to erase a useless profile. 
When the SC is open none ofopen, the saved asset profilesprofile willis benot automatically selected. To use anyit, ofselect theit savedmanually.

asset profiles, the user should choose one of them.

 

---

Generate the Asset

Generate the asset file by pressing the "Generate" button. If the generation operation will end successfully, in the location where the asset is generated three different files will become available.

• A binary (.bin) file containing all user defined artefacts that are part of a solution 
  
• A C++ header (.h) with all the symbolic names from the solution 
  
• An Extensible Markup Language (.xml) document that contains information about the asset items which accessed strings from the name table (offset, value, item name, etc.) 

---

 

Asset Generation Report

If the generating was done successfully and the checkbox "Display asset report" is checked, the "Asset Generation Report" dialog will appear. The report contains a list of all serialized items and the output of the script if the "Run script" checkbox was enabled.

The total sum of the items displayed in the "Asset Generation Report" is different than all the items summed up. This is the consequence of the fact that the "Total" size should match the size of the asset file which contains more data than the list of "regular" items. The asset header, the name table, AutoUniforms, ShaderAttributes and the index table of each sub lib (scenes, animations, etc.) contain additional information.

The content of this dialog can be saved in CSV (Comma Separated Values) format by clicking the "Save..." button.

---

 

Run Script

If enabled this option allows to run a script after the asset is generated. The syntax of the command is the following: 

Script_path [arg1] [arg2] [arg3] ...

• Script_path is absolute or relative to the solution 
  
• Arguments are optional 
  
• Arguments containing white spaces should be put between double quotes (e.g. "this is one argument") 
  
• The following macro variables can be used as arguments:
  
  • $AssetFileName: the path to the asset file 
    
  • $AssetProfileName: the name of the selected asset profile 
    
  • $CustomId: The Asset Id of the selected asset profile 
    

Example: 

c:\scripts\my_script.cmd $AssetProfileName "another param"

---

 

Missing Dependencies

In case of missing dependencies, no asset generation is possible. In this case, the "Missing Dependencies" dialog lists all items with missing dependencies:

---