Difference between revisions of "LlGetColor"

From Second Life Wiki
Jump to navigation Jump to search
(Add Blinn-Phong terminology to page following PBR release.)
 
(24 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|func=llGetColor
|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}}
|sort=GetColor
|func_id=52|func_sleep=0.0|func_energy=10.0
|func_id=52
|func=llGetColor|sort=GetColor
|func_sleep=0.0
|func_energy=10.0
|func_footnote
|func_footnote
|p1_type=integer
|p1_type=integer|p1_name=face
|p1_name=face
|p1_desc=The prim face you wish to get the color of.
|p2_type|p2_name|p2_desc
|p3_type|p3_name|p3_desc
|p4_type|p4_name|p4_desc
|p5_type|p5_name|p5_desc
|p6_type|p6_name|p6_desc
|p7_type|p7_name|p7_desc
|p8_type|p8_name|p8_desc
|p9_type|p9_name|p9_desc
|p10_type|p10_name|p10_desc
|p11_type|p11_name|p11_desc
|p12_type|p12_name|p12_desc
|return_type=vector
|return_type=vector
|return_text=that represents the RGB values for the color of the face.
|return_text=that is the [[PBR_Materials#Nomenclature_changes|Blinn-Phong]] color on {{LSLP|face}}.
|spec
|spec
|caveats
|caveats
|examples=
|examples=
<pre>
<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 39: Line 29:
|also_articles
|also_articles
|also_footer
|also_footer
|also_functions
|also_functions=
{{LSL DefineRow||[[llGetAlpha]]|Gets the prim's alpha}}
{{LSL DefineRow||[[llSetAlpha]]|Sets the prim's alpha}}
{{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
|notes
|notes
|cat1
|cat2
|cat3
|cat4
}}
}}
[[Category:LSL_Functions]][[Category:LSL_Stub]]

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 );