Quick API Index

The arcade module

Window and View Classes

Classes:

• NoOpenGLException

• View

• Window

Functions:

• get_screens

• open_window

Constants and Data Types:

• MOUSE_BUTTON_LEFT

• MOUSE_BUTTON_MIDDLE

• MOUSE_BUTTON_RIGHT

Arcade Data Types

Constants and Data Types:

• Color

• NamedPoint

• Point

• PointList

• RGB

• RGBA

• Rect

• RectList

• Vector

Buffered Draw Commands

Classes:

• Shape

• ShapeElementList

Functions:

• create_ellipse

• create_ellipse_filled

• create_ellipse_filled_with_colors

• create_ellipse_outline

• create_line

• create_line_generic

• create_line_generic_with_colors

• create_line_loop

• create_line_strip

• create_lines

• create_lines_with_colors

• create_polygon

• create_rectangle

• create_rectangle_filled

• create_rectangle_filled_with_colors

• create_rectangle_outline

• create_rectangles_filled_with_colors

• create_triangles_filled_with_colors

• get_rectangle_points

Constants and Data Types:

• TShape

OpenGL Context

Classes:

• ArcadeContext

Support for Drawing Commands

Functions:

• calculate_hit_box_points_detailed

• calculate_hit_box_points_simple

• get_four_byte_color

• get_four_float_color

• get_points_for_thick_line

• make_transparent_color

• rotate_point

Drawing Primitives

Functions:

• draw_arc_filled

• draw_arc_outline

• draw_circle_filled

• draw_circle_outline

• draw_ellipse_filled

• draw_ellipse_outline

• draw_line

• draw_line_strip

• draw_lines

• draw_lrtb_rectangle_filled

• draw_lrtb_rectangle_outline

• draw_lrwh_rectangle_textured

• draw_parabola_filled

• draw_parabola_outline

• draw_point

• draw_points

• draw_polygon_filled

• draw_polygon_outline

• draw_rectangle_filled

• draw_rectangle_outline

• draw_scaled_texture_rectangle

• draw_texture_rectangle

• draw_triangle_filled

• draw_triangle_outline

• draw_xywh_rectangle_filled

• draw_xywh_rectangle_outline

• get_image

• get_pixel

Earclip Collision Detection

Functions:

• earclip

Particle Emitter

Classes:

• EmitBurst

• EmitController

• EmitInterval

• EmitMaintainCount

• Emitter

• EmitterIntervalWithCount

• EmitterIntervalWithTime

Particle Emitter Simple

Functions:

• make_burst_emitter

• make_interval_emitter

Geometry Support

Functions:

• are_polygons_intersecting

• get_distance

• is_point_in_polygon

Isometric Map Support (incomplete)

Functions:

• create_isometric_grid_lines

• isometric_grid_to_screen

• screen_to_isometric_grid

Game Controller Support

Functions:

• get_game_controllers

• get_joysticks

Particle

Classes:

• EternalParticle

• FadeParticle

• LifetimeParticle

• Particle

Functions:

• clamp

Constants and Data Types:

• FilenameOrTexture

Pathfinding Support

Classes:

• AStarBarrierList

Functions:

• astar_calculate_path

• has_line_of_sight

Simple Physics Engines

Classes:

• PhysicsEnginePlatformer

• PhysicsEngineSimple

Pymunk Physics Engine

Classes:

• PymunkPhysicsEngine

• PymunkPhysicsObject

Sound Support

Classes:

• Sound

Functions:

• load_sound

• play_sound

• stop_sound

Sprites

Classes:

• AnimatedTimeBasedSprite

• AnimatedTimeSprite

• AnimatedWalkingSprite

• AnimationKeyframe

• PyMunk

• Sprite

• SpriteCircle

• SpriteSolidColor

Functions:

• get_distance_between_sprites

Constants and Data Types:

• FACE_DOWN

• FACE_LEFT

• FACE_RIGHT

• FACE_UP

Sprite Lists

Classes:

• SpriteList

Functions:

• check_for_collision

• check_for_collision_with_list

• get_closest_sprite

• get_sprites_at_exact_point

• get_sprites_at_point

Draw Text

Classes:

• CreateText

• Text

Functions:

• create_text

• draw_text

• draw_text_2

• get_text_image

• render_text

Constants and Data Types:

• DEFAULT_FONT_NAMES

OpenGL Texture Management

Classes:

• Matrix3x3

• Texture

Functions:

• cleanup_texture_cache

• load_spritesheet

• load_texture

• load_texture_pair

• load_textures

• make_circle_texture

• make_soft_circle_texture

• make_soft_square_texture

• trim_image

Loading TMX (Tiled Map Editor) Maps

Functions:

• get_tilemap_layer

• process_layer

• read_tmx

Misc Utility Functions

Functions:

• lerp

• lerp_vec

• rand_angle_360_deg

• rand_angle_spread_deg

• rand_in_circle

• rand_in_rect

• rand_on_circle

• rand_on_line

• rand_vec_magnitude

• rand_vec_spread_deg

Arcade Version Number

Constants and Data Types:

• VERSION

Window Commands

Functions:

• close_window

• create_orthogonal_projection

• finish_render

• get_display_size

• get_projection

• get_scaling_factor

• get_viewport

• get_window

• pause

• quick_run

• run

• schedule

• set_background_color

• set_viewport

• set_window

• start_render

• unschedule

The arcade.gl module

OpenGL Buffer

Classes:

• Buffer

OpenGL Context

Classes:

• Context

• ContextStats

• Limits

OpenGL Enums

Constants and Data Types:

• BLEND_ADDITIVE

• BLEND_DEFAULT

• BLEND_PREMULTIPLIED_ALPHA

• CLAMP_TO_BORDER

• CLAMP_TO_EDGE

• DST_ALPHA

• DST_COLOR

• FUNC_ADD

• FUNC_REVERSE_SUBTRACT

• FUNC_SUBTRACT

• LINEAR

• LINEAR_MIPMAP_LINEAR

• LINEAR_MIPMAP_NEAREST

• LINES

• LINES_ADJACENCY

• LINE_STRIP

• LINE_STRIP_ADJACENCY

• MAX

• MIN

• MIRRORED_REPEAT

• NEAREST

• NEAREST_MIPMAP_LINEAR

• NEAREST_MIPMAP_NEAREST

• ONE

• ONE_MINUS_DST_ALPHA

• ONE_MINUS_DST_COLOR

• ONE_MINUS_SRC_ALPHA

• ONE_MINUS_SRC_COLOR

• POINTS

• REPEAT

• SRC_ALPHA

• SRC_COLOR

• TRIANGLES

• TRIANGLES_ADJACENCY

• TRIANGLE_FAN

• TRIANGLE_STRIP

• TRIANGLE_STRIP_ADJACENCY

• ZERO

OpenGL Exceptions

Classes:

• ShaderException

OpenGL FrameBuffer

Classes:

• DefaultFrameBuffer

• Framebuffer

OpenGL Geometry

Functions:

• cube

• quad_2d

• quad_2d_fs

• screen_rectangle

OpenGL GLSL

Classes:

• ShaderSource

OpenGL Program

Classes:

• Program

OpenGL Query

Classes:

• Query

OpenGL Texture

Classes:

• Texture

OpenGL Types

Classes:

• AttribFormat

• BufferDescription

• GLTypes

• TypeInfo

Constants and Data Types:

• SHADER_TYPE_NAMES

• pixel_formats

OpenGL Uniform Data

Classes:

• Uniform

• UniformBlock

OpenGL Utils

Functions:

• data_to_ctypes

OpenGL Vertex Array (VAO)

Classes:

• Geometry

• VertexArray

The arcade.gui module

Core GUI

Classes:

• UIElement

• UIEvent

• UIException

Constants and Data Types:

• KEY_PRESS

• KEY_RELEASE

• MOUSE_MOTION

• MOUSE_PRESS

• MOUSE_RELEASE

• MOUSE_SCROLL

• TEXT_INPUT

• TEXT_MOTION

• TEXT_MOTION_SELECTION

GUI Manager

Classes:

• UIManager

GUI Style

Classes:

• UIStyle

GUI Utilities

Functions:

• add_margin

• get_image_with_text

• get_text_image

• parse_value

• render_text_image