TextBatchPrimitiveOptionalParameters Class |
Optional per-string and per-batch parameters for TextBatchPrimitive.
To use optional parameters, create an instance of TextBatchPrimitiveOptionalParameters,
then call the desired methods or properties to define per-string and per-batch parameters,
and finally pass the object to the text batch's Set or SetPartial method.
Inheritance HierarchyNamespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe TextBatchPrimitiveOptionalParameters type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TextBatchPrimitiveOptionalParameters |
Initializes default text batch primitive optional parameters.
|
Properties| Name | Description | |
|---|---|---|
 | EyeOffset |
Gets or sets the per-batch eye offset, which is applied to each string in the text batch.
|
| MaximumStringLength |
Gets or sets the maximum length of each string in the text batch.
|
| Origin |
Gets or sets the per-batch origin, which is applied to each string in the text batch.
|
| PixelOffset |
Gets or sets the per-batch pixel offset, which is applied to each string in the text batch.
|
| ScreenSpaceRendering |
Gets or sets a flag that informs the CTextBatchPrimitive to use rendering
optimized for screen space text.
|
Methods| Name | Description | |
|---|---|---|
| Dispose | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetColors |
Defines a collection of colors, one for each string in the batch.
|
| SetDisplays |
Defines a collection of boolean display flags,
one for each string in the batch.
|
| SetEyeOffsets |
Defines a collection of eye offsets, one for each string in the batch.
|
| SetOrigins |
Defines a collection of origins, one for each string in the batch.
|
| SetPixelOffsets |
Defines a collection of pixel offsets, one for each string in the batch.
|
| SetTimeIntervalDisplayConditions |
Defines a collection of
TimeIntervalDisplayConditions,
one for each string in the batch.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also