OsSetDynamicTextureDataFace

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(full width)
m (Change See Also)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{osslfunc
 
{{osslfunc
 
|threat_level=VeryLow
 
|threat_level=VeryLow
|permissions=${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
+
|permissions=${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
 
|delay=0
 
|delay=0
|function_syntax=string osSetDynamicTextureDataFace(string dynamicID, string contentType, string data, string extraParams, integer timer, integer face);
+
|function_syntax=key osSetDynamicTextureDataFace(string dynamicID, string contentType, string data, string extraParams, integer timer, integer face);
 
|ossl_example=<source lang="lsl">
 
|ossl_example=<source lang="lsl">
 
// Example of osSetDynamicTextureDataFace
 
// Example of osSetDynamicTextureDataFace
Line 21: Line 21:
 
</source>
 
</source>
 
|description=...
 
|description=...
|additional_info=This function was added in 0.9.0-post-fixes
+
|additional_info=
 
}}
 
}}
 
  
 
{| width="100%" style="border: thin solid black"
 
{| width="100%" style="border: thin solid black"
Line 32: Line 31:
 
|'''Remarks'''
 
|'''Remarks'''
 
|-
 
|-
|'''dynamicID'''
+
|style = style="vertical-align: top;" |'''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 dynamic texture
+
|style = 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 dynamic texture
| NOT IMPLEMENTED YET
+
|style = style="vertical-align: top;" |NOT IMPLEMENTED
 
|-
 
|-
|'''contentType'''  
+
|style = style="vertical-align: top;" |'''contentType'''  
|specifies the type of the '''data''' parameter.  
+
|style = style="vertical-align: top;" |specifies the type of the '''data''' parameter.  
 
The following values are allowed:
 
The following values are allowed:
 
* vector - the '''data''' parameter contains a list of drawing instructions. See [[Drawing commands]] for details
 
* vector - the '''data''' parameter contains a list of drawing instructions. See [[Drawing commands]] for details
 
|
 
|
 
|-
 
|-
|'''data'''
+
|style = style="vertical-align: top;" |'''data'''
|Contains a series of drawing instructions. See [[Drawing commands]] for details
+
|style = style="vertical-align: top;" |Contains a series of drawing instructions. See [[Drawing commands]] for details
 
|
 
|
 
|-
 
|-
|'''extraParams'''
+
|style = style="vertical-align: top;" |'''extraParams'''
|additional optional parameters in the following format: [param]:[value],[param]:[value]
+
|style = 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:
 
Multiple parameters are separated by commas. The following ones are supported:
 
* 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-clear to 255-solid (example: alpha:255)
 
* bgcolor - specifies the background color of the texture (example:  bgcolor:Red)
 
* bgcolor - specifies the background color of the texture (example:  bgcolor:Red)
 
* altdatadelim - specifies a delimiter between the draw commands contained in the '''data''' parameter.
 
* altdatadelim - specifies a delimiter between the draw commands contained in the '''data''' parameter.
* setalpha  
+
* setalpha - integer value is treated like specifying alpha component
* integer value  - any integer value is treated like specifying alpha component
+
* lossless - true or false, default false
 
|
 
|
 
|-
 
|-
|'''timer'''
+
|style = style="vertical-align: top;" |'''timer'''
|specify a time interval to update the texture
+
|style = style="vertical-align: top;" |specify a time interval to update the texture
|NOT IMPLEMENTED YET
+
|style = style="vertical-align: top;" |NOT IMPLEMENTED
 
|-
 
|-
|'''face'''
+
|style = style="vertical-align: top;" |'''face'''
|the face of the prim to display on
+
|style = style="vertical-align: top;" |the face of the prim to display on
 
|}
 
|}
  
 
'''Notes:'''
 
'''Notes:'''
  
# The '''dynamicID''' parameter is not yet implemented. The value passed will be ignored.
+
The '''dynamicID''' parameter is not yet implemented. The value passed will be ignored.<br>
# The '''timer''' parameter is not yet implemented. The value passed will be ignored. Instead, you can use a timer event and recall the function to get the same effect.
+
The '''timer''' parameter is not yet implemented. The value passed will be ignored. Instead, you can use a timer event and recall the function to get the same effect.<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>
 +
This function was added in 0.9.0.1<br>
  
'''See Also'''
+
== See Also ==
 
* [[osSetDynamicTextureURL]]
 
* [[osSetDynamicTextureURL]]
 
* [[osSetDynamicTextureURLBlend]]
 
* [[osSetDynamicTextureURLBlend]]

Latest revision as of 19:05, 5 December 2020

key osSetDynamicTextureDataFace(string dynamicID, string contentType, string data, string extraParams, integer timer, integer face);
...
Threat Level VeryLow
Permissions ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Extra Delay 0 seconds
Example(s)
// Example of osSetDynamicTextureDataFace
 
default
{
    state_entry()
    {
        string CommandList;
        CommandList = osSetFontName(CommandList, "Courier New");
        CommandList = osSetFontSize(CommandList, 14);
        CommandList = osMovePen(CommandList, 20, 20); 
        CommandList = osDrawText(CommandList, "A dynamic texture!");
        osSetDynamicTextureDataFace("", "vector", CommandList, "width:512,height:512", 0, 0);
    }
}


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 dynamic texture NOT IMPLEMENTED
contentType specifies the type of the data parameter.

The following values are allowed:

  • vector - the data parameter contains a list of drawing instructions. See Drawing commands for details
data Contains a series of drawing instructions. See Drawing commands for details
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)
  • bgcolor - specifies the background color of the texture (example: bgcolor:Red)
  • altdatadelim - specifies a delimiter between the draw commands contained in the data parameter.
  • setalpha - integer value is treated like specifying alpha component
  • lossless - true or false, default false
timer specify a time interval to update the texture NOT IMPLEMENTED
face the face of the prim to display on

Notes:

The dynamicID parameter is not yet implemented. The value passed will be ignored.
The timer parameter is not yet implemented. The value passed will be ignored. Instead, you can use a timer event and recall the function to get the same effect.
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
This function was added in 0.9.0.1

[edit] See Also

Personal tools
General
About This Wiki