OsSetDynamicTextureURLBlendFace

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{osslfunc
 
{{osslfunc
|threat_level=VeryLow
+
|threat_level=VeryHigh
 +
|permissions=ESTATE_MANAGER,ESTATE_OWNER
 +
|delay=0
 
|function_syntax=string osSetDynamicTextureURLBlendFace(string dynamicID, string contentType, string url, string extraParams, integer blend, integer disp, integer timer, integer alpha, integer face)
 
|function_syntax=string osSetDynamicTextureURLBlendFace(string dynamicID, string contentType, string url, string extraParams, integer blend, integer disp, integer timer, integer alpha, integer face)
 
|ossl_example=<source lang = "lsl">
 
|ossl_example=<source lang = "lsl">
 
// ----------------------------------------------------------------
 
// ----------------------------------------------------------------
// Example / Sample Script to show function use.
 
//
 
// Script Title:    osSetDynamicTextureURLBlendFace.lsl
 
// Script Author:
 
// Threat Level:    VeryLow
 
// Script Source:  http://opensimulator.org/wiki/osSetDynamicTextureURLBlendFace
 
//
 
// Notes: See Script Source reference for more detailed information
 
// This sample is full opensource and available to use as you see fit and desire.
 
// Threat Levels only apply to OSSL & AA Functions
 
// See http://opensimulator.org/wiki/Threat_level
 
// ================================================================
 
// C# Source Line:    public string osSetDynamicTextureURLBlendFace(string dynamicID, string contentType, string url, string extraParams, int blend, int timer, int alpha, int face)
 
// Inworld Script Line: osSetDynamicTextureURLBlendFace(string sDynamicID, string sContentType, string sURL, string sExtraParams, integer iBlend, integer iTimer, integer iAlpha, integer iFace);
 
 
//
 
//
 
// Example of osSetDynamicTextureURLBlendFace
 
// Example of osSetDynamicTextureURLBlendFace
Line 24: Line 12:
 
//    width - width of the dynamic texture in pixels (example: width:256)  
 
//    width - width of the dynamic texture in pixels (example: width:256)  
 
//    height - height of the dynamic texture in pixels (example: height:256)  
 
//    height - height of the dynamic texture in pixels (example: height:256)  
//    alpha - alpha (transparency) component of the dynamic texture. Values are from 0-clear to 255-solid, and false to turn off the alpha layer completely (example: alpha:255)
+
//    alpha - alpha (transparency) component of the dynamic texture. Values are from 0- full to 255 - solid
 
//    bgcolour - specifies the background color of the texture (example: bgcolour:Red)  
 
//    bgcolour - specifies the background color of the texture (example: bgcolour:Red)  
 
//    setalpha  
 
//    setalpha  
Line 43: Line 31:
 
         string sExtraParams = "width:512,height:512";    // optional parameters in the following format: [param]:[value],[param]:[value]
 
         string sExtraParams = "width:512,height:512";    // optional parameters in the following format: [param]:[value],[param]:[value]
 
         integer iBlend = TRUE;                          // TRUE = the newly generated texture is iBlended with the appropriate existing ones on the prim
 
         integer iBlend = TRUE;                          // TRUE = the newly generated texture is iBlended with the appropriate existing ones on the prim
         integer iDisp = 2;                              // 1 = expire deletes the old texture.  2 = temp means that it is not saved to the sDatabase.  
+
         integer iDisp = 2;                              // 1 = expire deletes the old texture.  2 = temp means that it is not saved to the Database.  
 
         integer iTimer = 0;                              // timer is not implemented yet, leave @ 0
 
         integer iTimer = 0;                              // timer is not implemented yet, leave @ 0
         integer iAlpha = 255;                            // 0 = 100% Alpha, 255 = 100% Solid
+
         integer iAlpha = 255;                            // 0 = 100% Transparent 255 = 100% Solid
 
         integer iFace = 0;                      // Faces of the prim, Select the Face you want
 
         integer iFace = 0;                      // Faces of the prim, Select the Face you want
 
         // Set the prepared texture to the Prim
 
         // Set the prepared texture to the Prim
Line 56: Line 44:
 
|
 
|
 
}}
 
}}
 +
 +
{|  width="100%" style="border: thin solid black"
 +
| colspan="3" align="center" style=background:orange | '''Parameters'''
 +
|-
 +
|'''Name'''
 +
|'''Description'''
 +
|'''Remarks'''
 +
|-
 +
|style="vertical-align: top;" |'''dynamicID'''
 +
|style="vertical-align: top;" |UUID of already existing dynamic texture. Intended to accept UUID from a previous call to osSetDynamicTextureXXXX functions in order to provide modification of an existing dynasmic texture
 +
|style="vertical-align: top;" |NOT IMPLEMENTED
 +
|-
 +
|style="vertical-align: top;" |'''contentType'''
 +
|style="vertical-align: top;" |specifies the type of the '''data''' parameter.
 +
The following values are allowed:
 +
* image
 +
|
 +
|-
 +
|style="vertical-align: top;" |'''url'''
 +
|style="vertical-align: top;" |the url of source image
 +
|
 +
|-
 +
|style="vertical-align: top;" |'''extraParams'''
 +
|style="vertical-align: top;" |additional optional parameters in the following format: [param]:[value],[param]:[value]
 +
Multiple parameters are separated by commas. The following ones are supported:
 +
* width - width of the dynamic texture in pixels (example:  width:256)
 +
* height - height of the dynamic texture in pixels (example:  height:256)
 +
* alpha - alpha (transparency) component of the dynamic texture. Values are from 0-clear to 255-solid.(example: alpha:255)
 +
* bgcolour - specifies the background color of the texture (example:  bgcolour:Red)
 +
* altdatadelim - specifies a delimiter between the draw commands contained in the '''data''' parameter.
 +
* setalpha - integer value is treated like specifing aplha component
 +
* lossless - true or false, default false
 +
 +
|
 +
|-
 +
|style="vertical-align: top;" |'''blend'''
 +
|style="vertical-align: top;" |If ''true'', the newly generated texture is blended with the appropriate existing ones on the prim.
 +
|
 +
|-
 +
|style="vertical-align: top;" |'''disp'''
 +
|style="vertical-align: top;" |Display flags. Value 1-expire deletes the old texture if it is replaced by a newer generated texture (may not currently be implemented). Value 2-temp flags the asset as temporary, which often means that it is not persisted to the database.
 +
|
 +
|-
 +
|style="vertical-align: top;" |'''timer'''
 +
|style="vertical-align: top;" |specify a time interval to update the texture
 +
|style="vertical-align: top;" |NOT IMPLEMENTED
 +
|-
 +
|style="vertical-align: top;" |'''alpha'''
 +
|style="vertical-align: top;" |The alpha value of the generated texture. 0 (full transparent) to 255 (solid)
 +
|
 +
|-
 +
|style="vertical-align: top;" |'''face'''
 +
|style="vertical-align: top;" |The face of the prim on which to put the generated texture.  If  ALL_SIDES then all sides of the prim are set.
 +
|
 +
|}
 +
 +
'''Notes:'''<br>
 +
'''lossless''' parameter added on version 0.9.1.1, Nov 4th 2019. Old versions did as true, but that should one be used if needed<br>

Latest revision as of 06:13, 7 November 2019

string osSetDynamicTextureURLBlendFace(string dynamicID, string contentType, string url, string extraParams, integer blend, integer disp, integer timer, integer alpha, integer face)
No descriptions provided
Threat Level VeryHigh
Permissions ESTATE_MANAGER,ESTATE_OWNER
Extra Delay 0 seconds
Example(s)
// ----------------------------------------------------------------
//
// Example of osSetDynamicTextureURLBlendFace
//
// ExtraParams Values:
//    width - width of the dynamic texture in pixels (example: width:256) 
//    height - height of the dynamic texture in pixels (example: height:256) 
//    alpha - alpha (transparency) component of the dynamic texture. Values are from 0- full to 255 - solid
//    bgcolour - specifies the background color of the texture (example: bgcolour:Red) 
//    setalpha 
//    integer value - any integer value is treated like specifing alpha component 
 
default
{
    state_entry()
    {
        llSay(0,"Touch to see osSetDynamicTextureURLBlendFace used to render Web Based Image/Texture on a prim");
    }
 
    touch_start(integer total_num)
    {
        string sDynamicID = "";                          // not implemented yet
        string sContentType = "image";                   // vector = text/lines,etc.  image = texture only
        string sURL = "http://www.goes.noaa.gov/FULLDISK/GMVS.JPG"; // URL for WebImage (Earth Shown)
        string sExtraParams = "width:512,height:512";    // optional parameters in the following format: [param]:[value],[param]:[value]
        integer iBlend = TRUE;                           // TRUE = the newly generated texture is iBlended with the appropriate existing ones on the prim
        integer iDisp = 2;                               // 1 = expire deletes the old texture.  2 = temp means that it is not saved to the Database. 
        integer iTimer = 0;                              // timer is not implemented yet, leave @ 0
        integer iAlpha = 255;                            // 0 = 100% Transparent 255 = 100% Solid
        integer iFace = 0;                       // Faces of the prim, Select the Face you want
        // Set the prepared texture to the Prim
        osSetDynamicTextureURLBlendFace( sDynamicID, sContentType, sURL, sExtraParams, iBlend, iDisp, iTimer, iAlpha, iFace );
    }
}


Parameters
Name Description Remarks
dynamicID UUID of already existing dynamic texture. Intended to accept UUID from a previous call to osSetDynamicTextureXXXX functions in order to provide modification of an existing dynasmic texture NOT IMPLEMENTED
contentType specifies the type of the data parameter.

The following values are allowed:

  • image
url the url of source image
extraParams additional optional parameters in the following format: [param]:[value],[param]:[value]

Multiple parameters are separated by commas. The following ones are supported:

  • width - width of the dynamic texture in pixels (example: width:256)
  • height - height of the dynamic texture in pixels (example: height:256)
  • alpha - alpha (transparency) component of the dynamic texture. Values are from 0-clear to 255-solid.(example: alpha:255)
  • bgcolour - specifies the background color of the texture (example: bgcolour:Red)
  • altdatadelim - specifies a delimiter between the draw commands contained in the data parameter.
  • setalpha - integer value is treated like specifing aplha component
  • lossless - true or false, default false
blend If true, the newly generated texture is blended with the appropriate existing ones on the prim.
disp Display flags. Value 1-expire deletes the old texture if it is replaced by a newer generated texture (may not currently be implemented). Value 2-temp flags the asset as temporary, which often means that it is not persisted to the database.
timer specify a time interval to update the texture NOT IMPLEMENTED
alpha The alpha value of the generated texture. 0 (full transparent) to 255 (solid)
face The face of the prim on which to put the generated texture. If ALL_SIDES then all sides of the prim are set.

Notes:
lossless parameter added on version 0.9.1.1, Nov 4th 2019. Old versions did as true, but that should one be used if needed

Personal tools
General
About This Wiki