About
Getting Started
Manual
on_draw()
on_update()
on_fixed_update()
arcade.Clock
arcade.FixedClock
Contributing
Community
API Reference
HasAddSubMul
TiledObject
repr(self)
name
properties
shape
type
SupportsDunderLT
SupportsDunderGT
AnchorPoint
BOTTOM_CENTER
BOTTOM_LEFT
BOTTOM_RIGHT
CENTER
CENTER_LEFT
CENTER_RIGHT
TOP_CENTER
TOP_LEFT
TOP_RIGHT
Color
a
b
from_gray()
from_hex_string()
from_iterable()
from_normalized()
from_uint24()
from_uint32()
g
normalized
r
random()
replace()
rgb
swizzle()
RectKwargs
bottom
height
left
right
top
width
x
y
Rect
self & other
bool(self)
math.ceil(self)
point in self
math.floor(self)
self * scale
self | other
round(self, n)
self / scale
align_bottom()
align_center()
align_center_x()
align_center_y()
align_left()
align_right()
align_top()
align_x()
align_y()
area
aspect_ratio
at_position()
bottom_center
bottom_left
bottom_right
center
center_left
center_right
center_x
center_y
clamp_height()
clamp_size()
clamp_width()
distance_from_bounds()
from_kwargs()
get_relative_to_anchor()
intersection()
kwargs
lbwh
lrbt
max_size()
min_size()
move()
overlaps()
point_in_bounds()
point_in_rect()
point_on_bounds()
position_to_uv()
resize()
scale()
scale_axes()
size
to_points()
top_center
top_left
top_right
union()
uv_to_position()
viewport
xyrr
xywh
resolve_resource_path()
resolve()
add_resource_handle()
get_resource_handle_paths()
list_built_in_assets()
load_system_fonts()
draw_arc_filled()
draw_arc_outline()
draw_circle_filled()
draw_circle_outline()
draw_ellipse_filled()
draw_ellipse_outline()
get_points_for_thick_line()
draw_line_strip()
draw_line()
draw_lines()
draw_parabola_filled()
draw_parabola_outline()
draw_point()
draw_points()
draw_polygon_filled()
draw_polygon_outline()
draw_texture_rect()
draw_sprite()
draw_sprite_rect()
draw_lrbt_rectangle_outline()
draw_lbwh_rectangle_outline()
draw_lrbt_rectangle_filled()
draw_lbwh_rectangle_filled()
draw_rect_outline()
draw_rect_filled()
draw_triangle_filled()
draw_triangle_outline()
Shape
draw()
ShapeElementList
iter(self)
len(self)
angle
append()
clear()
position
remove()
update()
create_line()
create_line_generic_with_colors()
create_line_generic()
create_line_strip()
create_line_loop()
create_lines()
create_lines_with_colors()
create_polygon()
create_rectangle_filled()
create_rectangle_outline()
get_rectangle_points()
create_rectangle()
create_rectangle_filled_with_colors()
create_rectangles_filled_with_colors()
create_triangles_filled_with_colors()
create_triangles_strip_filled_with_colors()
create_ellipse_filled()
create_ellipse_outline()
create_ellipse()
create_ellipse_filled_with_colors()
load_animated_gif()
BasicSprite
alpha
collides_with_list()
collides_with_point()
collides_with_sprite()
color
depth
draw_hit_box()
hit_box
kill()
rect
register_sprite_list()
remove_from_sprite_lists()
rescale_relative_to_point()
rescale_xy_relative_to_point()
scale
scale_x
scale_y
sprite_lists
texture
update_animation()
update_spatial_hash()
visible
Sprite
append_texture()
boundary_bottom
boundary_left
boundary_right
boundary_top
change_angle
change_x
change_y
cur_texture_index
force
forward()
guid
physics_engines
radians
register_physics_engine()
reverse()
set_texture()
stop()
strafe()
sync_hit_box_to_texture()
textures
turn_left()
turn_right()
velocity
SpriteSolidColor
from_rect()
SpriteCircle
PyMunk
damping
gravity
max_horizontal_velocity
max_velocity
max_vertical_velocity
PymunkMixin
pymunk
pymunk_moved()
TextureKeyframe
duration
tile_id
TextureAnimation
duration_ms
duration_seconds
get_keyframe()
keyframes
num_frames
TextureAnimationSprite
animation
time
AnimatedWalkingSprite
Camera2D
aabb()
activate()
equalise()
from_camera_data()
match_screen()
point_in_view()
project()
projection
projection_data
projection_far
projection_near
render_target
scissor
unproject()
up
use()
view_data
viewport_bottom
viewport_height
viewport_left
viewport_right
viewport_top
viewport_width
zoom
SpriteList
DEFAULT_TEXTURE_FILTER
sprite in self
self[index] = sprite
alpha_normalized
atlas
blend
buffer_angles
buffer_colors
buffer_indices
buffer_positions
buffer_sizes
buffer_textures
color_normalized
disable_spatial_hashing()
draw_hit_boxes()
enable_spatial_hashing()
extend()
geometry
index()
initialize()
insert()
pop()
preload_textures()
rescale()
shuffle()
sort()
swap()
write_sprite_buffers_to_gpu()
SpatialHash
add()
cell_size
count
get_sprites_near_point()
get_sprites_near_rect()
get_sprites_near_sprite()
hash()
reset()
get_distance_between_sprites()
get_closest_sprite()
check_for_collision()
check_for_collision_with_list()
check_for_collision_with_lists()
get_sprites_at_point()
get_sprites_at_exact_point()
get_sprites_in_rect()
SceneKeyError
Scene
item in self
del self[sprite_list]
self[key]
add_sprite()
add_sprite_list()
add_sprite_list_after()
add_sprite_list_before()
from_tilemap()
get_sprite_list()
move_sprite_list_after()
move_sprite_list_before()
remove_sprite_list_by_index()
remove_sprite_list_by_name()
remove_sprite_list_by_object()
Clock
delta_time
dt
set_tick_speed()
speed
t
tick()
tick_count
ticks
ticks_since()
time_since()
FixedClock
accumulated
fraction
rate
Text
align
anchor_x
anchor_y
batch
bold
content_height
content_size
content_width
draw_debug()
em_to_px()
font_name
font_size
group
italic
multiline
px_to_em()
rotation
text
tracking
value
z
load_font()
create_text_sprite()
draw_text()
TileMap
background_color
get_cartesian()
get_tilemap_layer()
object_lists
offset
scaling
tile_height
tile_width
tiled_map
load_tilemap()
read_tmx()
ImageData
calculate_hash()
hash
hash_func
image
Texture
atlas_name
cache_name
create_atlas_name()
create_cache_name()
create_empty()
create_image_cache_name()
crop()
crop_values
file_path
flip_diagonally()
flip_horizontally()
flip_left_right()
flip_top_bottom()
flip_vertically()
hit_box_algorithm
hit_box_points
image_cache_name
image_data
rotate_180()
rotate_270()
rotate_90()
transform()
transpose()
transverse()
validate_crop()
load_texture()
load_image()
load_spritesheet()
make_circle_texture()
make_soft_circle_texture()
make_soft_square_texture()
TextureCacheManager
flush()
hit_box_cache
image_data_cache
load_or_get_image()
load_or_get_spritesheet()
load_or_get_spritesheet_texture()
load_or_get_texture()
texture_cache
SpriteSheet
flip_flags
from_image()
get_image()
get_image_grid()
get_texture()
get_texture_grid()
path
get_default_texture()
get_default_image()
calculate_hit_box_points_simple()
calculate_hit_box_points_detailed()
HitBoxAlgorithm
self(*, **)
cache
calculate()
create_bounding_box()
HitBox
create_rotatable()
get_adjusted_points()
points
RotatableHitBox
BoundingHitBoxAlgorithm
SimpleHitBoxAlgorithm
PymunkHitBoxAlgorithm
self(*, detail)
default_detail
select_largest_line_set()
to_points_list()
trace_image()
VertexOrder
LOWER_LEFT
LOWER_RIGHT
UPPER_LEFT
UPPER_RIGHT
Transform
order
transform_hit_box_points()
transform_texture_coordinates_order()
transform_vertex_order()
Rotate90Transform
Rotate180Transform
Rotate270Transform
FlipLeftRightTransform
FlipTopBottomTransform
TransposeTransform
TransverseTransform
TextureAtlasBase
ctx
fbo
get_image_region_info()
get_texture_id()
get_texture_region_info()
has_image()
has_texture()
has_unique_texture()
layers
read_texture_image_from_atlas()
rebuild()
render_into()
save()
show()
to_image()
update_texture_image()
update_texture_image_from_atlas()
use_uv_texture()
write_image()
DefaultTextureAtlas
auto_resize
border
image_uv_texture
images
max_height
max_size
max_width
texture_uv_texture
unique_textures
AtlasRegion
texture_coordinates
verify_image_size()
UVData
clone_with_slots()
free_slot_by_name()
get_existing_or_free_slot()
get_slot_or_raise()
num_free_slots
num_slots
set_slot_data()
write_to_texture()
ImageDataRefCounter
count_all_refs()
debug_print()
dec_ref()
dec_ref_by_hash()
get_ref_count()
get_total_decref()
inc_ref()
UniqueTextureRefCounter
dec_ref_by_atlas_name()
print_timings()
clear_timings()
get_timings()
enable_timings()
disable_timings()
get_fps()
timings_enabled()
PerfGraph
axis_color
font_color
graph_data
grid_color
line_color
update_graph()
PhysicsEngineSimple
player_sprite
walls
PhysicsEnginePlatformer
allow_multi_jump
allowed_jumps
can_jump()
disable_multi_jump()
enable_multi_jump()
gravity_constant
increment_jump_counter()
is_on_ladder()
jump()
jumps_since_ground
ladders
platforms
PymunkPhysicsObject
PymunkException
PymunkPhysicsEngine
DYNAMIC
KINEMATIC
MOMENT_INF
STATIC
add_collision_handler()
apply_force()
apply_impulse()
apply_opposite_running_force()
check_grounding()
get_physics_object()
get_sprite_for_shape()
get_sprites_from_arbiter()
is_on_ground()
remove_sprite()
resync_sprites()
set_friction()
set_horizontal_velocity()
set_position()
set_rotation()
set_velocity()
step()
configure_logging()
Chain
as_type()
type_name()
is_iterable()
is_nonstr_iterable()
is_str_or_noniterable()
grow_sequence()
copy_dunders_unimplemented()
is_raspberry_pi()
get_raspberry_pi_info()
are_polygons_intersecting()
is_point_in_box()
get_triangle_orientation()
are_lines_intersecting()
is_point_in_polygon()
ControllerManager
get_controllers()
get_joysticks()
get_game_controllers()
NoOpenGLException
Window
center_window()
close()
current_camera
current_view
default_camera
dispatch_events()
fixed_delta_time
fixed_time
flip()
get_location()
get_size()
get_system_mouse_cursor()
headless
hide_view()
keyboard
maximize()
minimize()
mouse
on_action()
on_key_press()
on_key_release()
on_mouse_drag()
on_mouse_enter()
on_mouse_leave()
on_mouse_motion()
on_mouse_press()
on_mouse_release()
on_mouse_scroll()
on_resize()
run()
set_caption()
set_draw_rate()
set_exclusive_keyboard()
set_exclusive_mouse()
set_fullscreen()
set_location()
set_maximum_size()
set_minimum_size()
set_mouse_platform_visible()
set_mouse_visible()
set_size()
set_update_rate()
set_visible()
set_vsync()
show_view()
switch_to()
test()
View
on_hide_view()
on_show_view()
get_screens()
open_window()
get_display_size()
get_window()
set_window()
close_window()
exit()
start_render()
finish_render()
set_background_color()
schedule()
unschedule()
schedule_once()
Section
accept_keyboard_keys
accept_mouse_events
block_updates
camera
draw_order
enabled
get_xy_screen_relative()
get_xy_section_relative()
local_mouse_coordinates
modal
mouse_is_on_top()
on_hide_section()
on_show_section()
overlaps_with()
prevent_dispatch
prevent_dispatch_view
section_manager
should_receive_mouse_event()
view
window
SectionManager
add_section()
clear_sections()
disable()
disable_all_keyboard_events()
dispatch_keyboard_event()
dispatch_mouse_enter_leave_events()
dispatch_mouse_event()
enable()
get_first_section()
get_section_by_name()
get_sections()
has_sections
is_current_view
remove_section()
sections
sort_section_event_order()
sort_sections_draw_order()
get_pixel()
Sound
get_length()
get_stream_position()
get_volume()
is_complete()
is_playing()
play()
set_volume()
load_sound()
play_sound()
stop_sound()
ZeroProjectionDimension
CameraData
forward
OrthographicProjectionData
far
near
PerspectiveProjectionData
aspect
fov
Projection
Projector
duplicate_camera_data()
constrain_camera_data()
orthographic_from_rect()
generate_view_matrix()
generate_orthographic_matrix()
generate_perspective_matrix()
project_orthographic()
unproject_orthographic()
project_perspective()
unproject_perspective()
OrthographicProjector
generate_projection_matrix()
PerspectiveProjector
ViewportProjector
DefaultProjector
static_from_orthographic()
static_from_perspective()
static_from_raw_orthographic()
static_from_raw_perspective()
static_from_matrices()
AStarBarrierList
grid_size
moving_sprite
blocking_sprites
barrier_list
recalculate()
astar_calculate_path()
has_line_of_sight()
isometric_grid_to_screen()
screen_to_isometric_grid()
create_isometric_grid_lines()
earclip()
EasingData
cur_period
ease_function
end_period
end_value
start_period
start_value
linear()
smoothstep()
ease_in()
ease_out()
ease_in_out()
ease_out_elastic()
ease_out_bounce()
ease_in_back()
ease_out_back()
ease_in_sin()
ease_out_sin()
ease_in_out_sin()
easing()
ease_angle()
ease_angle_update()
ease_value()
ease_position()
ease_update()
ArcadeContext
atlas_size
bind_window_block()
default_atlas
get_framebuffer_image()
load_compute_shader()
load_program()
projection_matrix
shader_inc()
view_matrix
clamp()
lerp()
lerp_2d()
lerp_3d()
lerp_angle()
rand_in_rect()
rand_in_circle()
rand_on_circle()
rand_on_line()
rand_angle_360_deg()
rand_angle_spread_deg()
rand_vec_spread_deg()
rand_vec_magnitude()
get_distance()
rotate_point()
get_angle_degrees()
get_angle_radians()
quaternion_rotation()
Texture2D
Buffer
Geometry
BufferDescription
VertexArray
quad_2d_fs()
quad_2d()
screen_rectangle()
cube()
Framebuffer
DefaultFrameBuffer
Query
Program
ComputeShader
Uniform
UniformBlock
ShaderSource
data_to_ctypes()
ShaderException
OutsideRangeError
IntOutsideRangeError
FloatOutsideRangeError
ByteRangeError
NormalizedRangeError
PerformanceWarning
ReplacementWarning
warning()
StartFinishRenderData
begin()
end()
crate_str_from_values()
crate_str_from_list()
HitBoxCache
VERSION
get()
load()
put()
TextureBucket
delete()
delete_by_value()
TextureCache
texture in self
del self[name]
self[name]
self[name] = texture
get_all_textures()
get_texture_by_filepath()
get_with_config()
ImageDataCache
RenderTargetTexture
InputType
CONTROLLER_AXIS
CONTROLLER_BUTTON
KEYBOARD
MOUSE_AXIS
MOUSE_BUTTON
InputEnum
StrEnum
format(self, format_spec)
ControllerAxes
LEFT_STICK_NEGATIVE_X
LEFT_STICK_NEGATIVE_Y
LEFT_STICK_POSITIVE_X
LEFT_STICK_POSITIVE_Y
LEFT_STICK_X
LEFT_STICK_Y
LEFT_TRIGGER
RIGHT_STICK_NEGATIVE_X
RIGHT_STICK_NEGATIVE_Y
RIGHT_STICK_POSITIVE_X
RIGHT_STICK_POSITIVE_Y
RIGHT_STICK_X
RIGHT_STICK_Y
RIGHT_TRIGGER
ControllerButtons
BACK
BOTTOM_FACE
DPAD_DOWN
DPAD_LEFT
DPAD_RIGHT
DPAD_UP
GUIDE
LEFT_FACE
LEFT_SHOULDER
LEFT_STICK
RIGHT_FACE
RIGHT_SHOULDER
RIGHT_STICK
START
TOP_FACE
XBoxControllerButtons
A
B
LEFT_BUMPER
RIGHT_BUMPER
SELECT
X
Y
PSControllerButtons
CIRCLE
CROSS
L1
R1
SQUARE
TRIANGLE
Keys
AMPERSAND
APOSTROPHE
ASCIICIRCUM
ASCIITILDE
ASTERISK
AT
BACKSLASH
BACKSPACE
BAR
BEGIN
BRACELEFT
BRACERIGHT
BRACKETLEFT
BRACKETRIGHT
BREAK
C
CANCEL
CAPSLOCK
CLEAR
COLON
COMMA
D
DELETE
DOLLAR
DOUBLEQUOTE
DOWN
E
END
ENTER
EQUAL
ESCAPE
EXCLAMATION
EXECUTE
F
F1
F10
F11
F12
F13
F14
F15
F16
F17
F18
F19
F2
F20
F21
F22
F23
F24
F3
F4
F5
F6
F7
F8
F9
FIND
G
GRAVE
GREATER
H
HASH
HELP
HOME
I
INSERT
J
K
KEY_0
KEY_1
KEY_2
KEY_3
KEY_4
KEY_5
KEY_6
KEY_7
KEY_8
KEY_9
L
LALT
LCOMMAND
LCTRL
LEFT
LESS
LINEFEED
LMETA
LOPTION
LSHIFT
LWINDOWS
M
MENU
MINUS
MODESWITCH
MOD_ACCEL
MOD_ALT
MOD_CAPSLOCK
MOD_COMMAND
MOD_CTRL
MOD_NUMLOCK
MOD_OPTION
MOD_SCROLLLOCK
MOD_SHIFT
MOD_WINDOWS
MOTION_BACKSPACE
MOTION_BEGINNING_OF_FILE
MOTION_BEGINNING_OF_LINE
MOTION_DELETE
MOTION_DOWN
MOTION_END_OF_FILE
MOTION_END_OF_LINE
MOTION_LEFT
MOTION_NEXT_PAGE
MOTION_NEXT_WORD
MOTION_PREVIOUS_PAGE
MOTION_PREVIOUS_WORD
MOTION_RIGHT
MOTION_UP
N
NUMLOCK
NUM_0
NUM_1
NUM_2
NUM_3
NUM_4
NUM_5
NUM_6
NUM_7
NUM_8
NUM_9
NUM_ADD
NUM_BEGIN
NUM_DECIMAL
NUM_DELETE
NUM_DIVIDE
NUM_DOWN
NUM_END
NUM_ENTER
NUM_EQUAL
NUM_F1
NUM_F2
NUM_F3
NUM_F4
NUM_HOME
NUM_INSERT
NUM_LEFT
NUM_MULTIPLY
NUM_NEXT
NUM_PAGE_DOWN
NUM_PAGE_UP
NUM_PRIOR
NUM_RIGHT
NUM_SEPARATOR
NUM_SPACE
NUM_SUBTRACT
NUM_TAB
NUM_UP
O
P
PAGEDOWN
PAGEUP
PARENLEFT
PARENRIGHT
PAUSE
PERCENT
PERIOD
PLUS
POUND
PRINT
Q
QUESTION
QUOTELEFT
R
RALT
RCOMMAND
RCTRL
REDO
RETURN
RIGHT
RMETA
ROPTION
RSHIFT
RWINDOWS
S
SCRIPTSWITCH
SCROLLLOCK
SEMICOLON
SLASH
SPACE
SYSREQ
T
TAB
U
UNDERSCORE
UNDO
UP
V
W
Z
MouseAxes
MouseButtons
MIDDLE
MOUSE_1
MOUSE_2
MOUSE_3
MOUSE_4
MOUSE_5
parse_mapping_input_enum()
RawInputManager
actions
axes
controller_deadzone
ActionState
PRESSED
RELEASED
InputDevice
CONTROLLER
InputManager
add_action_input()
add_axis_input()
allow_keyboard
axis()
bind_controller()
clear_action_input()
clear_axis_input()
copy_existing()
dispatch_action()
from_existing()
new_action()
new_axis()
on_button_press()
on_button_release()
on_dpad_motion()
on_stick_motion()
on_trigger_motion()
parse()
register_action_handler()
remove_action()
remove_axis()
serialize()
subscribe_to_action()
unbind_controller()
Action
add_mapping()
remove_mapping()
Axis
InputMapping
ActionMapping
AxisMapping
serialize_action()
parse_raw_axis()
serialize_axis()
RawBindBase
input
input_type
RawActionMapping
mod_alt
mod_ctrl
mod_shift
RawAxisMapping
RawAction
mappings
RawAxis
BackgroundTexture
from_file()
pixel_transform
render_target()
wrap_x
wrap_y
Background
blend_layer()
color_norm
pos
BackgroundGroup
add_from_file()
ParallaxGroup
change_depth()
Light
HARD
SOFT
radius
LightLayer
diffuse_texture
light_texture
VideoPlayer
get_video_size()
VideoPlayerView
UIMessageBox
UIButtonRow
add_button()
UIDraggableMixin
do_layout()
on_event()
UIMouseFilterMixin
UIWindowLikeMixin
Surface
blend_func_render
blend_func_render_into
draw_texture()
limit()
pixel_ratio
size_scaled
UIManager
OVERLAY_LAYER
adjust_mouse_coordinates()
debug()
dispatch_ui_event()
execute_layout()
get_widgets_at()
on_text()
on_text_motion()
on_text_motion_select()
trigger_render()
walk_widgets()
NinePatchTexture
draw_rect()
program
UIView
add_widget()
on_draw_after_ui()
on_draw_before_ui()
UIWidget
center_on_screen()
children
content_rect
do_render()
do_render_base()
padding
prepare_render()
size_hint
size_hint_max
size_hint_min
trigger_full_render()
with_background()
with_border()
with_padding()
UIInteractiveWidget
disabled
hovered
on_click()
pressed
UIDummy
UISpriteWidget
UILayout
min_size_of()
prepare_layout()
UISpace
UITextureButtonStyle
UITextureButton
DEFAULT_STYLE
UIStyle
get_current_state()
texture_hovered
texture_pressed
UIFlatButtonStyle
bg
border_width
UIFlatButton
STYLE_BLUE
STYLE_RED
UIDropdown
DIVIDER
on_change()
UIAnchorLayout
default_anchor_x
default_anchor_y
UIBoxLayout
fit_content()
UIGridLayout
UIBaseSlider
norm_value
UISliderStyle
filled_track
unfilled_track
UISlider
UITextureSlider
UILabel
ADAPTIVE_MULTILINE_WIDTH
update_font()
UITextWidget
place_text()
ui_label
UIInputText
LAYOUT_OFFSET
active
deactivate()
UITextArea
UITextureToggle
UIImage
UIEvent
source
UIMouseEvent
UIMouseMovementEvent
dx
dy
UIMousePressEvent
button
modifiers
UIMouseDragEvent
buttons
UIMouseReleaseEvent
UIMouseScrollEvent
scroll_x
scroll_y
UIKeyEvent
symbol
UIKeyPressEvent
UIKeyReleaseEvent
UITextEvent
UITextInputEvent
UITextMotionEvent
motion
UITextMotionSelectEvent
selection
UIOnClickEvent
UIOnUpdateEvent
UIOnChangeEvent
new_value
old_value
UIOnActionEvent
action
Property
bind()
default_factory
dispatch()
obs
set()
unbind()
DictProperty
ListProperty
UIStyleBase
UIStyledWidget
get_current_style()
style
UIPasswordInput
UIScrollBar
UIScrollArea
invert_scroll
scroll_speed
UITypedTextInput
parsed_type