Sketch

Core py5 class for leveraging py5’s functionality.

Description

Core py5 class for leveraging py5’s functionality. This is analogous to the PApplet class in Processing. Launch the Sketch with the run_sketch() method.

The core functions to be implemented by the py5 coder are setup and draw. The first will be run once at Sketch initialization and the second will be run in an animation thread, once per frame. The following event functions are also supported:

• exiting

• key_pressed

• key_released

• key_typed

• mouse_clicked

• mouse_dragged

• mouse_entered

• mouse_exited

• mouse_moved

• mouse_pressed

• mouse_released

• mouse_wheel

• movie_event

• predraw_update

• post_draw

• pre_draw

When coding in class mode, all of the above functions should be instance methods. When coding in module mode or imported mode, the above functions should be stand-alone functions available in the local namespace in which run_sketch() was called.

For more information, look at the online “User Functions” documentation.

Underlying Processing class: PApplet

The following methods and fields are provided:

Color Creating / Reading alpha() blue() brightness() color() green() hex_color() hue() lerp_color() red() saturation() Setting background() clear() color_mode() fill() no_fill() no_stroke() stroke() Constants java_platform java_version_name Environment cursor() display_density() display_height display_width focused frame_count frame_rate() full_screen() get_frame_rate() get_surface() height no_cursor() no_smooth() pixel_density() pixel_height pixel_width ratio_left ratio_scale ratio_top rheight rwidth size() sketch_path() smooth() width window_move() window_ratio() window_resizable() window_resize() window_title() window_x window_y Image create_image() Loading / Displaying convert_cached_image() convert_image() create_image_from_numpy() image() image_mode() load_image() no_tint() request_image() tint() Pixels apply_filter() blend() copy() get_np_pixels() get_pixels() load_np_pixels() load_pixels() np_pixels[] pixels[] set_np_pixels() set_pixels() to_pil() update_np_pixels() update_pixels() Textures texture() texture_mode() texture_wrap() Input Files load_bytes() load_json() load_pickle() load_strings() parse_json() save_json() select_folder() select_input() Keyboard is_key_pressed key key_code Mouse is_mouse_pressed mouse_button mouse_x mouse_y pmouse_x pmouse_y rmouse_x rmouse_y Time & Date day() hour() millis() minute() month() second() year()

Lights & Camera Camera begin_camera() camera() end_camera() frustum() ortho() perspective() print_camera() print_projection() Coordinates model_x() model_y() model_z() screen_x() screen_y() screen_z() Lights ambient_light() directional_light() light_falloff() light_specular() lights() no_lights() normal() point_light() spot_light() Material Properties ambient() emissive() shininess() specular() Math Calculation ceil() constrain() dist() exp() floor() lerp() log() mag() norm() remap() sq() sqrt() Random noise() noise_detail() noise_seed() np_random os_noise() os_noise_seed() random() random_choice() random_gaussian() random_int() random_sample() random_seed() Trigonometry acos() asin() atan() atan2() cos() degrees() radians() sin() tan() Output Files begin_raw() begin_record() end_raw() end_record() save_bytes() save_pickle() save_strings() select_output() Image save() save_frame() Text Area println() set_println_stream() Rendering blend_mode() clip() create_graphics() flush() get_graphics() hint() no_clip() Shaders load_shader() reset_shader() shader()

Shape convert_cached_shape() convert_shape() create_shape() load_shape() 2D Primitives arc() circle() ellipse() line() lines() point() points() quad() rect() square() triangle() 3D Primitives box() sphere() sphere_detail() Attributes ellipse_mode() rect_mode() stroke_cap() stroke_join() stroke_weight() Curves bezier() bezier_detail() bezier_point() bezier_tangent() curve() curve_detail() curve_point() curve_tangent() curve_tightness() Loading / Displaying shape() shape_mode() Vertex begin_closed_shape() begin_contour() begin_shape() bezier_vertex() bezier_vertices() curve_vertex() curve_vertices() end_contour() end_shape() quadratic_vertex() quadratic_vertices() vertex() vertices() Structure exit_sketch() finished hot_reload_draw() is_dead is_dead_from_error is_ready is_running loop() no_loop() pargs pop() pop_style() print_line_profiler_stats() profile_draw() profile_functions() push() push_style() redraw() run_sketch() Threading has_thread() join_thread() launch_promise_thread() launch_repeating_thread() launch_thread() list_threads() stop_all_threads() stop_thread() Transform apply_matrix() get_matrix() pop_matrix() print_matrix() push_matrix() reset_matrix() rotate() rotate_x() rotate_y() rotate_z() scale() set_matrix() shear_x() shear_y() translate() Typography Attributes text_align() text_leading() text_mode() text_size() text_width() Loading / Displaying create_font() load_font() text() text_font() Metrics text_ascent() text_descent()

Updated on March 18, 2024 05:08:14am UTC