Mesh.TextFromFont Method

Language:

Creates a mesh that contains the specified text, using a .NET font object.

Definition

Visual Basic Public Shared Function TextFromFont( _
    ByVal device As Device, _
    ByVal font As Font, _
    ByVal text As String, _
    ByVal deviation As Single, _
    ByVal extrusion As Single, _
    ByRef adjacency As GraphicsStream, _
    ByRef glyphMetrics As GlyphMetricsFloat _
) As Mesh

C# public static Mesh TextFromFont(
    Device device,
    Font font,
    string text,
    float deviation,
    float extrusion,
    out GraphicsStream adjacency,
    out GlyphMetricsFloat glyphMetrics
);

C++ public:
static Mesh^ TextFromFont(
    Device^ device,
    Font^ font,
    String^ text,
    float deviation,
    float extrusion,
    [Out] GraphicsStream^% adjacency,
    [Out] GlyphMetricsFloat% glyphMetrics
);

JScript public static function TextFromFont(
    device : Device,
    font : Font,
    text : String,
    deviation : float,
    extrusion : float,
    adjacency : GraphicsStream,
    glyphMetrics : GlyphMetricsFloat
) : Mesh;

Visual Basic	Public Shared Function TextFromFont( _ ByVal device As Device, _ ByVal font As Font, _ ByVal text As String, _ ByVal deviation As Single, _ ByVal extrusion As Single, _ ByRef adjacency As GraphicsStream, _ ByRef glyphMetrics As GlyphMetricsFloat _ ) As Mesh
C#	public static Mesh TextFromFont( Device device, Font font, string text, float deviation, float extrusion, out GraphicsStream adjacency, out GlyphMetricsFloat glyphMetrics );
C++	public: static Mesh^ TextFromFont( Device^ device, Font^ font, String^ text, float deviation, float extrusion, [Out] GraphicsStream^% adjacency, [Out] GlyphMetricsFloat% glyphMetrics );
JScript	public static function TextFromFont( device : Device, font : Font, text : String, deviation : float, extrusion : float, adjacency : GraphicsStream, glyphMetrics : GlyphMetricsFloat ) : Mesh;

Parameters

device Microsoft.DirectX.Direct3D.Device
A Device object that represents the device associated with the text mesh.

font System.Drawing.Font
A Font object that creates the mesh.

text System.String
String that specifies the text to generate.

deviation System.Single
Maximum chordal deviation from font outlines.

extrusion System.Single
Amount to extrude text in the negative z-direction.

adjacency Microsoft.DirectX.GraphicsStream
A GraphicsStream object containing an array of three Int32 values per face that specify the three neighbors for each face in the mesh.

glyphMetrics Microsoft.DirectX.Direct3D.GlyphMetricsFloat[]
Array of GlyphMetricsFloat structures that contain the glyph metric data. See Remarks. If glyph sizes are not a concern, this parameter can be omitted.

Return Value

Microsoft.DirectX.Direct3D.Mesh
A Mesh object that represents the cylinder mesh.

Remarks

Each element contains information about the position and orientation of the corresponding glyph in the string. The number of elements in the array should be equal to the number of characters in the string. Note that the origin in each structure is not relative to the entire string, but rather is relative to that character cell. To compute the entire bounding box, add the increment for each glyph while traversing the string.

Exceptions

InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.

InvalidDataException The data is invalid.

OutOfMemoryException Microsoft Direct3D could not allocate sufficient memory to complete the call.

device	Microsoft.DirectX.Direct3D.Device A Device object that represents the device associated with the text mesh.
font	System.Drawing.Font A Font object that creates the mesh.
text	System.String String that specifies the text to generate.
deviation	System.Single Maximum chordal deviation from font outlines.
extrusion	System.Single Amount to extrude text in the negative z-direction.
adjacency	Microsoft.DirectX.GraphicsStream A GraphicsStream object containing an array of three Int32 values per face that specify the three neighbors for each face in the mesh.
glyphMetrics	Microsoft.DirectX.Direct3D.GlyphMetricsFloat[] Array of GlyphMetricsFloat structures that contain the glyph metric data. See Remarks. If glyph sizes are not a concern, this parameter can be omitted.

InvalidCallException	The method call is invalid. For example, a method's parameter might contain an invalid value.
InvalidDataException	The data is invalid.
OutOfMemoryException	Microsoft Direct3D could not allocate sufficient memory to complete the call.