TextBatchPrimitiveOptionalParametersSetPixelOffsets Method |
Defines a collection of pixel offsets, one for each string in the batch.
Namespace:
AGI.Foundation.Graphics
Assembly:
AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public void SetPixelOffsets(
IEnumerable<PointF> pixelOffsets
)
Public Sub SetPixelOffsets (
pixelOffsets As IEnumerable(Of PointF)
)
public:
void SetPixelOffsets(
IEnumerable<PointF>^ pixelOffsets
)
member SetPixelOffsets :
pixelOffsets : IEnumerable<PointF> -> unit
Parameters
- pixelOffsets
- Type: System.Collections.GenericIEnumerablePointF
The pixel offsets for each string in the batch. There must be one pixel offset for
each string passed to the
TextBatchPrimitive's
Set or SetPartial method.
Remarks
The pixel offset defines a screen-space translation for a string from its
position. Positive x values translate to the right and positive y values translate up.
This is commonly used when more than one primitive is located
at the same position. For example, if a string in a text batch and a
point in a point batch have the same position, the string may have a
pixel offset applied to it so it doesn't overlap the point.
Per-string pixel offsets override the per-batch pixel offset. Therefore, when
per-string pixel offsets are defined with this method,
PixelOffset is ignored.
See Also