BlobBuilder
Creates blob assets.
Read time 2 minutesLast updated 2 days ago
Definition
- Type: Struct
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
- Implements: IDisposable
public struct BlobBuilder : IDisposable
Remarks
A blob asset is an immutable data structure stored in unmanaged memory. Blob assets can contain primitive types, strings, structs, arrays, and arrays of arrays. Arrays and structs must only contain blittable types. Strings must be of type BlobString (or a specialized unmanaged string type).
To use a BlobBuilder object to create a blob asset:
- Declare the structure of the blob asset as a struct.
- Create a BlobBuilder object.
- Call the BlobBuilder.ConstructRoot method, where is the struct defining the asset structure.
T - Initialize primitive values defined at the root level of the asset.
- Allocate memory for arrays, structs, and BlobString instances at the root.
- Initialize the values of those arrays, structs, and strings.
- Continue allocating memory and initializing values until you have fully constructed the asset.
- Call BlobBuilder.CreateBlobAssetReference to create a reference to the blob asset in memory.
- Dispose the BlobBuilder object.
Use the BlobAssetReference<T> returned by BlobBuilder.CreateBlobAssetReference to reference the blob asset. You can use a BlobAssetReference<T> as a field of an IComponentData struct. More than one entity can reference the same blob asset.
Call BlobAssetReference<T>.Dispose to free the memory allocated for a blob asset.
Blob assets cannot be modified once created. Instead, you must create a new blob asset, update any references to the old one and then dispose of it.
Constructors
Constructor | Description |
|---|---|
| BlobBuilder(Unity.Collections.AllocatorManager.AllocatorHandle,System.Int32) | Constructs a BlobBuilder object. |
Properties
Property | Description |
|---|---|
| IsCreated | Returns true if this BlobBuilder has been allocated. |
Methods
Method | Description |
|---|---|
| Allocate | Allocates enough memory to store |
| Construct | Copies an array of structs to an array in a blob asset after allocating the necessary memory. |
| ConstructRoot | Creates the top-level fields of a single blob asset. |
| CreateBlobAssetReference | Completes construction of the blob asset and returns a reference to the asset in unmanaged memory. |
| Dispose | Disposes of this BlobBuilder instance and frees its temporary memory allocations. |
| SetPointer | Sets a BlobPtr to point to the given object inside the blob. |