OsDrawImage

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Removed 'Template:' prefix from template includings and/or changed external-link into internal-link)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Quicklinks}}
+
{{osslfunc
{| width="100%" style="border: thin solid black"
+
|threat_level=ignored
| colspan="2" align="center" style=background:orange | '''{{SUBPAGENAME}}'''
+
|permissions=true
|- valign="top"
+
|function_syntax=string osDrawImage(string drawList, integer width, integer height, string imageUrl)
|'''Threat Level''' || <Threat Level goes here>
+
|ossl_example=<source lang="lsl">
|- valign="top"
+
|'''Function Syntax''' || <source lang="lsl">
+
LSL: string osDrawImage( string drawList, integer width, integer height, string imageUrl )
+
C#: string osDrawImage( string drawList, int width, int height, string imageUrl )
+
</source>
+
|- valign="top"
+
|'''Example(s)||<source lang="lsl">
+
 
// Example of osDrawImage
 
// Example of osDrawImage
 
default
 
default
Line 26: Line 19:
 
}
 
}
 
</source>
 
</source>
|}
+
|description=Appends an [[Drawing commands#Image|Image]] drawing command to the string provided in '''drawList''' and returns the result.
Appends an [[Drawing_commands#Image|Image]] drawing command to the string provided in '''drawList''' and returns the result.
+
  
 
Retrieves an image specified by the imageUrl parameter and draws it at the specified height and width, with the upper left corner of the image placed at the pen's current position. After the image is drawn, the width and height values are added to the pen's X and Y position, respectively (that is, the pen's current position is set to the lower right corner of the image).  
 
Retrieves an image specified by the imageUrl parameter and draws it at the specified height and width, with the upper left corner of the image placed at the pen's current position. After the image is drawn, the width and height values are added to the pen's X and Y position, respectively (that is, the pen's current position is set to the lower right corner of the image).  
  
 
If imageUrl points to an invalid location, an image type not supported by libgdi, or a non-image MIME type, nothing is drawn. If either or both of the '''width''' or '''height''' parameters are zero or negative, nothing is drawn, but the image is still retrieved.  
 
If imageUrl points to an invalid location, an image type not supported by libgdi, or a non-image MIME type, nothing is drawn. If either or both of the '''width''' or '''height''' parameters are zero or negative, nothing is drawn, but the image is still retrieved.  
 
+
|
[[Category:OSSL Functions]]
+
}}
[[Category:OSSL functions without threat level]]
+

Latest revision as of 19:53, 25 September 2019

string osDrawImage(string drawList, integer width, integer height, string imageUrl)
Appends an Image drawing command to the string provided in drawList and returns the result.

Retrieves an image specified by the imageUrl parameter and draws it at the specified height and width, with the upper left corner of the image placed at the pen's current position. After the image is drawn, the width and height values are added to the pen's X and Y position, respectively (that is, the pen's current position is set to the lower right corner of the image).

If imageUrl points to an invalid location, an image type not supported by libgdi, or a non-image MIME type, nothing is drawn. If either or both of the width or height parameters are zero or negative, nothing is drawn, but the image is still retrieved.

Threat Level This function does not do a threat level check
Permissions Use of this function is always allowed by default
Delay No function delay specified
Example(s)
// Example of osDrawImage
default
{
    state_entry()
    {
        string CommandList = ""; // Storage for our drawing commands
        string ImageURL = "http://opensimulator.org/skins/osmonobook/images/headerLogo.png";
        CommandList = osMovePen( CommandList, 0, 0 );                // Upper left corner at <0,0>
        CommandList = osDrawImage( CommandList, 256, 54, ImageURL ); // 200 pixels by 100 pixels
 
        // Now draw the image
        osSetDynamicTextureData( "", "vector", CommandList, "width:256,height:256", 0 );
    }
}


Personal tools
General
About This Wiki