OsGetDrawStringSize
From OpenSimulator
(Difference between revisions)
m (Removed 'Template:' prefix from template includings and/or changed external-link into internal-link) |
|||
| Line 1: | Line 1: | ||
{{Quicklinks}} | {{Quicklinks}} | ||
| + | {| width="100%" style="border: thin solid black" | ||
| + | | colspan="2" align="center" style=background:orange | '''{{SUBPAGENAME}}''' | ||
| + | |- valign="top" | ||
| + | |'''Threat Level''' || <Threat Level goes here> | ||
| − | + | |- valign="top" | |
| − | C#: | + | |'''Function Syntax''' || <source lang="lsl"> |
| − | + | LSL: vector osGetDrawStringSize( string contentType, string text, string fontName, integer fontSize ) | |
| − | + | C#: LSL_Vector osGetDrawStringSize( string contentType, string text, string fontName, int fontSize ) | |
| − | + | </source> | |
| − | + | |- valign="top" | |
| − | + | |'''Example(s)||<source lang="lsl"> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | <source lang="lsl"> | + | |
// Example of osGetDrawStringSize | // Example of osGetDrawStringSize | ||
default | default | ||
| Line 33: | Line 32: | ||
} | } | ||
</source> | </source> | ||
| + | |} | ||
| + | |||
| + | Returns a vector containing the horizontal and vertical dimensions in pixels of the specified text, if drawn in the specified font and at the specified point size. The horizontal extent is returned in the '''.x''' component of the vector, and the vertical extent is returned in '''.y'''. The '''.z''' component is not used. | ||
| + | |||
| + | The contentType parameter should be "vector". | ||
| + | |||
| + | If the [[OsSetFontSize | osSetFontSize()]] function has not been used, and neither the [[Drawing_commands#FontName | FontName]] nor [[Drawing_commands#FontProp | FontProp]] commands have been added to the draw list, specify "Arial" as the font name, and 14 as the font size. | ||
| − | [[Category:OSSL]] | + | [[Category:OSSL Functions]] |
[[Category:OSSL functions without threat level]] | [[Category:OSSL functions without threat level]] | ||
Revision as of 08:26, 11 June 2011
 |
Languages: |
|
| OsGetDrawStringSize | |
| Threat Level | <Threat Level goes here> |
| Function Syntax | LSL: vector osGetDrawStringSize( string contentType, string text, string fontName, integer fontSize ) C#: LSL_Vector osGetDrawStringSize( string contentType, string text, string fontName, int fontSize ) |
| Example(s) | // Example of osGetDrawStringSize default { state_entry() { string CommandList = ""; // Storage for our drawing commands string TextToDraw = "Hello, World!"; // text to draw vector Extents = osGetDrawStringSize( "vector", TextToDraw, "Arial", 14 ); integer xpos = 128 - ((integer) Extents.x >> 1); // Center the text horizontally integer ypos = 127 - ((integer) Extents.y >> 1); // and vertically CommandList = osMovePen( CommandList, xpos, ypos ); // Position the text CommandList = osDrawText( CommandList, TextToDraw ); // Place the text // Now draw the text osSetDynamicTextureData( "", "vector", CommandList, "width:256,height:256", 0 ); } } |
Returns a vector containing the horizontal and vertical dimensions in pixels of the specified text, if drawn in the specified font and at the specified point size. The horizontal extent is returned in the .x component of the vector, and the vertical extent is returned in .y. The .z component is not used.
The contentType parameter should be "vector".
If the osSetFontSize() function has not been used, and neither the FontName nor FontProp commands have been added to the draw list, specify "Arial" as the font name, and 14 as the font size.
