Difference between revisions of "LlGetColor"

From Second Life Wiki
Jump to navigation Jump to search
(Add Blinn-Phong terminology to page following PBR release.)
 
(15 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{LSL Function/color|none}}{{LSL_Function/face|face}}
{{LSL_Function
{{LSL_Function
|inject-2={{LSL_Function/face|face|return={{LSL VR|0.0|0.0|0.0}}|get=returns the average color of all the faces on the prim.{{Footnote|Since sRGB is nonlinear this color may not in fact be of the greatest use.}}}}{{LSL Function/color|none}}
|func_id=52|func_sleep=0.0|func_energy=10.0
|func=llGetColor|sort=GetColor
|func=llGetColor|sort=GetColor
|func_id=52|func_sleep=0.0|func_energy=10.0
|func_footnote
|func_footnote
|p1_type=integer|p1_name=face
|p1_type=integer|p1_name=face
|return_type=vector
|return_type=vector
|return_text=that is the color on '''face'''.
|return_text=that is the [[PBR_Materials#Nomenclature_changes|Blinn-Phong]] color on {{LSLP|face}}.
|spec
|spec
|caveats
|caveats
|examples=<pre>
|examples=
<syntaxhighlight lang="lsl2">// Tells the owner the color on all sides
default
default
{
{
     state_entry()
     state_entry()
     {
     {
         llSay(0,"The color of side 1 is: "+(string)llGetColor(1) );
         integer i = 0;
        integer max = llGetNumberOfSides();
        while(i < max)
        {
            llOwnerSay("Face " + (string) i + " color is " + (string) llGetColor(i));
            ++i;
        }
     }
     }
}
}</syntaxhighlight>
</pre>
|helpers
|helpers
|also_header
|also_header
Line 27: Line 33:
{{LSL DefineRow||[[llSetAlpha]]|Sets the prim's alpha}}
{{LSL DefineRow||[[llSetAlpha]]|Sets the prim's alpha}}
{{LSL DefineRow||[[llSetColor]]|Sets the prim's color}}
{{LSL DefineRow||[[llSetColor]]|Sets the prim's color}}
{{LSL DefineRow||[[llSetLinkColor]]|Sets link's color}}
{{LSL DefineRow||[[llSetLinkAlpha]]|Sets link's alpha}}
{{LSL DefineRow||[[llGetNumberOfSides]]|Gets the number of faces on the prim}}
|also_events
|also_events
|also_articles
|also_articles

Latest revision as of 12:27, 1 December 2023

Summary

Function: vector llGetColor( integer face );
0.0 Forced Delay
10.0 Energy

Returns a vector that is the Blinn-Phong color on face.

• integer face face number or ALL_SIDES

If face is ALL_SIDES then the function returns the average color of all the faces on the prim.[1]

Caveats

  • If face indicates a face that does not exist the return is <0.0, 0.0, 0.0>

Examples

// Tells the owner the color on all sides
default
{
    state_entry()
    {
        integer i = 0;
        integer max = llGetNumberOfSides();
        while(i < max)
        {
            llOwnerSay("Face " + (string) i + " color is " + (string) llGetColor(i));
            ++i;
        }
    }
}

See Also

Functions

•  llGetAlpha Gets the prim's alpha
•  llSetAlpha Sets the prim's alpha
•  llSetColor Sets the prim's color
•  llSetLinkColor Sets link's color
•  llSetLinkAlpha Sets link's alpha
•  llGetNumberOfSides Gets the number of faces on the prim

Articles

•  Color in LSL

Deep Notes

Footnotes

  1. ^ Since sRGB is nonlinear this color may not in fact be of the greatest use.

Signature

function vector llGetColor( integer face );