Py5Shape.ambient()

Py5Shape.ambient()#

Sets a Py5Shape object’s ambient reflectance.

Examples#

example picture for ambient()

def create_strip(use_ambient):
    s = py5.create_shape()
    s.begin_shape(py5.TRIANGLE_STRIP)
    if use_ambient:
        s.ambient(255, 0, 0)
    s.vertex(10, 40, -25)
    s.vertex(20, 0, -10)
    s.vertex(30, 40, 0)
    s.vertex(40, 0, 5)
    s.vertex(50, 40, 0)
    s.vertex(60, 0, -10)
    s.vertex(70, 40, -25)
    s.end_shape()
    return s


def setup():
    py5.size(100, 100, py5.P3D)
    py5.background(0)
    py5.directional_light(153, 153, 153, .5, 0, -1)
    py5.ambient_light(50, 50, 50)
    py5.shape(create_strip(False), 0, 5)
    py5.shape(create_strip(True), 0, 50)

Description#

Sets a Py5Shape object’s ambient reflectance. This is combined with the ambient light component of the environment. The color components set through the parameters define the reflectance. For example in the default color mode, setting ambient(255, 127, 0), would cause all the red light to reflect and half of the green light to reflect. Use in combination with Py5Shape.emissive(), Py5Shape.specular(), and Py5Shape.shininess() to set the material properties of a Py5Shape object.

This method can only be used within a Py5Shape.begin_shape() and Py5Shape.end_shape() pair. The ambient color setting will be applied to vertices added after the call to this method.

This method has additional color functionality that is not reflected in the method’s signatures. For example, you can pass the name of a color (e.g. “green”, “mediumpurple”, etc). Look at the online “All About Colors” Python Ecosystem Integration tutorial for more information.

Underlying Processing method: PShape.ambient

Signatures#

ambient(
    gray: float,  # number specifying value between white and black
    /,
) -> None

ambient(
    rgb: int,  # any value of the color datatype
    /,
) -> None

ambient(
    x: float,  # red or hue value (depending on current color mode)
    y: float,  # green or saturation value (depending on current color mode)
    z: float,  # blue or brightness value (depending on current color mode)
    /,
) -> None

Updated on December 25, 2023 16:36:33pm UTC

Contents