Struct LogMemoryManagerParameters
Initialization parameters for LogMemoryManager.
Inherited Members
Namespace: Unity.Logging
Assembly: solution.dll
Syntax
[BurstCompile]
[GenerateTestsForBurstCompatibility]
public struct LogMemoryManagerParameters
Fields
| Name | Description |
|---|---|
| BufferGrowFactor | Factor by which the default Payload container increases in size, when growth threshold is reached. |
| BufferGrowThreshold | Default Payload container capacity will increase in size when the average usage goes over this ratio. |
| BufferSampleCount | Number of samples used for computing moving average of default Payload container capacity. |
| BufferShrinkFactor | Factor by which the default Payload container decreases in size, when shrink threshold is reached. |
| BufferShrinkThreshold | Default Payload container capacity will decrease in size when the average usage goes below this ratio. |
| DefaultBufferCapacity | Default value for InitialBufferCapacity |
| DefaultBufferGrowFactor | Default value for BufferGrowFactor |
| DefaultBufferGrowThreshold | Default value for BufferGrowThreshold |
| DefaultBufferSampleCount | Default value for BufferSampleCount |
| DefaultBufferShrinkFactor | Default value for BufferShrinkFactor |
| DefaultBufferShrinkThreshold | Default value for BufferShrinkThreshold |
| DefaultDispatchQueueSize | Default value for DispatchQueueSize |
| DefaultOverflowBufferSize | Default value for OverflowBufferSize |
| DispatchQueueSize | Max count of Log messages between updates. DispatchQueue |
| InitialBufferCapacity | Starting size of the default Payload container. |
| OverflowBufferSize | Size of the "overflow" buffer, which is another UnsafePayloadRingBuffer instance, to hold allocations if the default buffer becomes full. |
Properties
| Name | Description |
|---|---|
| Default | Get default settings |
| HeavyLoad | Get heavy load settings |
| IsAutomaticBufferGrowthEnabled | Returns if automatic Payload container growth is specifically enabled. |
| IsAutomaticBufferResizeEnabled | Returns if automatic Payload container resizing is enabled at all. |
| IsAutomaticBufferShrinkEnabled | Returns if automatic Payload container shrink is specifically enabled. |
| IsOverflowBufferEnabled | True if Overflow Buffer is used (its size > 0). OverflowBufferSize |
Methods
| Name | Description |
|---|---|
| GetDefaultParameters(out LogMemoryManagerParameters) | Creates a LogMemoryManagerParameters instance holding default values. |
| GetHeavyLoadParameters(out LogMemoryManagerParameters) | Creates a LogMemoryManagerParameters instance holding heavy-load-case values. |