Référence API de Pyxel

Référence API de Pyxel, un moteur de jeux rétro pour Python.

Avancé

Système

variablewidth

La largeur de l'écran.

Détails

Type

int

variableheight

La hauteur de l'écran.

Détails

Type

int

variableframe_count

Le nombre de frames écoulées.

Détails

Type

int

function

init(width, height, title="Pyxel", fps=30, quit_key=KEY_ESCAPE, display_scale=None, capture_scale=2, capture_sec=10, headless=False)

Initialise l'application Pyxel avec la taille d'écran (width, height).

Détails

Paramètres

width (int) — Largeur de l'écran

height (int) — Hauteur de l'écran

title (str) — Titre de la fenêtre. Par défaut : "Pyxel".

fps (int) — Fréquence d'images. Par défaut : 30.

quit_key (int) — Touche pour quitter. Par défaut : KEY_ESCAPE.

display_scale (int) — Facteur d'échelle d'affichage. Si omis, déterminé automatiquement.

capture_scale (int) — Facteur d'échelle de capture. Par défaut : 2.

capture_sec (int) — Durée maximale d'enregistrement vidéo. Par défaut : 10.

headless (bool) — Exécuter sans fenêtre. Par défaut : False.

Exemple

pyxel.init(160, 120, title="My Pyxel App", fps=60, quit_key=pyxel.KEY_NONE, capture_scale=3, capture_sec=0)

functionrun(update, draw)

Démarre l'application Pyxel et appelle la fonction update pour la mise à jour des frames et la fonction draw pour le dessin.

Détails

Paramètres

update (callable) — Fonction de mise à jour de la logique de jeu par image

draw (callable) — Fonction de dessin de l'écran par image

functionshow()

Affiche l'écran et attend que la touche de fermeture soit pressée.

functionflip()

Rafraîchit l'écran d'une frame. L'application se termine lorsque la touche de fermeture est pressée. Cette fonction n'est pas disponible dans la version web.

functionquit()

Quitte l'application Pyxel.

functionreset()

Redémarre l'application Pyxel depuis le début.

Ressource

functionload(filename, exclude_images=False, exclude_tilemaps=False, exclude_sounds=False, exclude_musics=False)

Charge le fichier de ressources (.pyxres). Si une option est définie sur True, la ressource correspondante ne sera pas chargée.

Détails

Paramètres

filename (str) — Nom du fichier de ressources

exclude_images (bool) — Exclure les banques d'images. Par défaut : False.

exclude_tilemaps (bool) — Exclure les tilemaps. Par défaut : False.

exclude_sounds (bool) — Exclure les sons. Par défaut : False.

exclude_musics (bool) — Exclure les pistes de musique. Par défaut : False.

Remarque

Si un fichier de palette (.pyxpal) portant le même nom existe, les couleurs d'affichage de la palette seront également mises à jour.

Entrée

variablemouse_x

La position X actuelle du curseur de la souris.

Détails

Type

int

variablemouse_y

La position Y actuelle du curseur de la souris.

Détails

Type

int

variablemouse_wheel

La valeur actuelle de la molette de la souris.

Détails

Type

int

functionbtn(key)

Renvoie True si la touche est enfoncée, sinon False.

Détails

Paramètres

key (int) — Code de touche

Retour

bool — True si pressé

functionbtnp(key, hold=0, repeat=0)

Renvoie True si la touche est pressée dans ce frame. Lorsque hold et repeat sont spécifiés, après avoir maintenu la touche pendant hold frames, renvoie True tous les repeat frames.

Détails

Paramètres

key (int) — Code de touche

hold (int) — Frames de maintien avant le début de la répétition. Par défaut : 0.

repeat (int) — Intervalle de répétition en frames. Si 0, pas de répétition.

Retour

bool — True si pressé dans cette frame

functionbtnr(key)

Renvoie True si la touche est relâchée dans ce frame, sinon False.

Détails

Paramètres

key (int) — Code de touche

Retour

bool — True si relâché dans cette frame

functionmouse(visible)

Affiche le curseur de la souris si visible est True, et le masque si False. La position du curseur continue d'être mise à jour même lorsqu'il est masqué.

Détails

Paramètres

visible (bool) — Afficher ou masquer le curseur

Constantes de touches

Touches spéciales

KEY_UNKNOWNKEY_RETURNKEY_ESCAPEKEY_BACKSPACEKEY_TABKEY_SPACEKEY_NONE

Lettres

KEY_AKEY_BKEY_CKEY_DKEY_EKEY_FKEY_GKEY_HKEY_IKEY_JKEY_KKEY_LKEY_MKEY_NKEY_OKEY_PKEY_QKEY_RKEY_SKEY_TKEY_UKEY_VKEY_WKEY_XKEY_YKEY_Z

Chiffres

KEY_0KEY_1KEY_2KEY_3KEY_4KEY_5KEY_6KEY_7KEY_8KEY_9

Symboles

KEY_EXCLAIMKEY_QUOTEDBLKEY_HASHKEY_PERCENTKEY_DOLLARKEY_AMPERSANDKEY_QUOTEKEY_LEFTPARENKEY_RIGHTPARENKEY_ASTERISKKEY_PLUSKEY_COMMAKEY_MINUSKEY_PERIODKEY_SLASHKEY_COLONKEY_SEMICOLONKEY_LESSKEY_EQUALSKEY_GREATERKEY_QUESTIONKEY_ATKEY_LEFTBRACKETKEY_BACKSLASHKEY_RIGHTBRACKETKEY_CARETKEY_UNDERSCOREKEY_BACKQUOTE

Fonction

KEY_F1KEY_F2KEY_F3KEY_F4KEY_F5KEY_F6KEY_F7KEY_F8KEY_F9KEY_F10KEY_F11KEY_F12KEY_F13KEY_F14KEY_F15KEY_F16KEY_F17KEY_F18KEY_F19KEY_F20KEY_F21KEY_F22KEY_F23KEY_F24

Navigation

KEY_INSERTKEY_HOMEKEY_PAGEUPKEY_DELETEKEY_ENDKEY_PAGEDOWNKEY_RIGHTKEY_LEFTKEY_DOWNKEY_UP

Modificateurs

KEY_CAPSLOCKKEY_LCTRLKEY_LSHIFTKEY_LALTKEY_LGUIKEY_RCTRLKEY_RSHIFTKEY_RALTKEY_RGUIKEY_SHIFTKEY_CTRLKEY_ALTKEY_GUI

Pavé numérique

KEY_NUMLOCKCLEARKEY_KP_DIVIDEKEY_KP_MULTIPLYKEY_KP_MINUSKEY_KP_PLUSKEY_KP_ENTERKEY_KP_1KEY_KP_2KEY_KP_3KEY_KP_4KEY_KP_5KEY_KP_6KEY_KP_7KEY_KP_8KEY_KP_9KEY_KP_0KEY_KP_PERIODKEY_KP_EQUALSKEY_KP_COMMAKEY_KP_EQUALSAS400KEY_KP_00KEY_KP_000KEY_KP_LEFTPARENKEY_KP_RIGHTPARENKEY_KP_LEFTBRACEKEY_KP_RIGHTBRACEKEY_KP_TABKEY_KP_BACKSPACEKEY_KP_AKEY_KP_BKEY_KP_CKEY_KP_DKEY_KP_EKEY_KP_FKEY_KP_XORKEY_KP_POWERKEY_KP_PERCENTKEY_KP_LESSKEY_KP_GREATERKEY_KP_AMPERSANDKEY_KP_DBLAMPERSANDKEY_KP_VERTICALBARKEY_KP_DBLVERTICALBARKEY_KP_COLONKEY_KP_HASHKEY_KP_SPACEKEY_KP_ATKEY_KP_EXCLAMKEY_KP_MEMSTOREKEY_KP_MEMRECALLKEY_KP_MEMCLEARKEY_KP_MEMADDKEY_KP_MEMSUBTRACTKEY_KP_MEMMULTIPLYKEY_KP_MEMDIVIDEKEY_KP_PLUSMINUSKEY_KP_CLEARKEY_KP_CLEARENTRYKEY_KP_BINARYKEY_KP_OCTALKEY_KP_DECIMALKEY_KP_HEXADECIMAL

Système et médias

KEY_PRINTSCREENKEY_SCROLLLOCKKEY_PAUSEKEY_APPLICATIONKEY_POWERKEY_EXECUTEKEY_HELPKEY_MENUKEY_SELECTKEY_STOPKEY_AGAINKEY_UNDOKEY_CUTKEY_COPYKEY_PASTEKEY_FINDKEY_MUTEKEY_VOLUMEUPKEY_VOLUMEDOWNKEY_ALTERASEKEY_SYSREQKEY_CANCELKEY_CLEARKEY_PRIORKEY_RETURN2KEY_SEPARATORKEY_OUTKEY_OPERKEY_CLEARAGAINKEY_CRSELKEY_EXSELKEY_THOUSANDSSEPARATORKEY_DECIMALSEPARATORKEY_CURRENCYUNITKEY_CURRENCYSUBUNIT

Constantes de souris

Curseur et molette

MOUSE_POS_XMOUSE_POS_YMOUSE_WHEEL_XMOUSE_WHEEL_Y

Boutons

MOUSE_BUTTON_LEFTMOUSE_BUTTON_MIDDLEMOUSE_BUTTON_RIGHTMOUSE_BUTTON_X1MOUSE_BUTTON_X2

Constantes de manette

Manette 1

GAMEPAD1_AXIS_LEFTXGAMEPAD1_AXIS_LEFTYGAMEPAD1_AXIS_RIGHTXGAMEPAD1_AXIS_RIGHTYGAMEPAD1_AXIS_TRIGGERLEFTGAMEPAD1_AXIS_TRIGGERRIGHTGAMEPAD1_BUTTON_AGAMEPAD1_BUTTON_BGAMEPAD1_BUTTON_XGAMEPAD1_BUTTON_YGAMEPAD1_BUTTON_BACKGAMEPAD1_BUTTON_GUIDEGAMEPAD1_BUTTON_STARTGAMEPAD1_BUTTON_LEFTSTICKGAMEPAD1_BUTTON_RIGHTSTICKGAMEPAD1_BUTTON_LEFTSHOULDERGAMEPAD1_BUTTON_RIGHTSHOULDERGAMEPAD1_BUTTON_DPAD_UPGAMEPAD1_BUTTON_DPAD_DOWNGAMEPAD1_BUTTON_DPAD_LEFTGAMEPAD1_BUTTON_DPAD_RIGHT

Manette 2

GAMEPAD2_AXIS_LEFTXGAMEPAD2_AXIS_LEFTYGAMEPAD2_AXIS_RIGHTXGAMEPAD2_AXIS_RIGHTYGAMEPAD2_AXIS_TRIGGERLEFTGAMEPAD2_AXIS_TRIGGERRIGHTGAMEPAD2_BUTTON_AGAMEPAD2_BUTTON_BGAMEPAD2_BUTTON_XGAMEPAD2_BUTTON_YGAMEPAD2_BUTTON_BACKGAMEPAD2_BUTTON_GUIDEGAMEPAD2_BUTTON_STARTGAMEPAD2_BUTTON_LEFTSTICKGAMEPAD2_BUTTON_RIGHTSTICKGAMEPAD2_BUTTON_LEFTSHOULDERGAMEPAD2_BUTTON_RIGHTSHOULDERGAMEPAD2_BUTTON_DPAD_UPGAMEPAD2_BUTTON_DPAD_DOWNGAMEPAD2_BUTTON_DPAD_LEFTGAMEPAD2_BUTTON_DPAD_RIGHT

Manette 3

GAMEPAD3_AXIS_LEFTXGAMEPAD3_AXIS_LEFTYGAMEPAD3_AXIS_RIGHTXGAMEPAD3_AXIS_RIGHTYGAMEPAD3_AXIS_TRIGGERLEFTGAMEPAD3_AXIS_TRIGGERRIGHTGAMEPAD3_BUTTON_AGAMEPAD3_BUTTON_BGAMEPAD3_BUTTON_XGAMEPAD3_BUTTON_YGAMEPAD3_BUTTON_BACKGAMEPAD3_BUTTON_GUIDEGAMEPAD3_BUTTON_STARTGAMEPAD3_BUTTON_LEFTSTICKGAMEPAD3_BUTTON_RIGHTSTICKGAMEPAD3_BUTTON_LEFTSHOULDERGAMEPAD3_BUTTON_RIGHTSHOULDERGAMEPAD3_BUTTON_DPAD_UPGAMEPAD3_BUTTON_DPAD_DOWNGAMEPAD3_BUTTON_DPAD_LEFTGAMEPAD3_BUTTON_DPAD_RIGHT

Manette 4

GAMEPAD4_AXIS_LEFTXGAMEPAD4_AXIS_LEFTYGAMEPAD4_AXIS_RIGHTXGAMEPAD4_AXIS_RIGHTYGAMEPAD4_AXIS_TRIGGERLEFTGAMEPAD4_AXIS_TRIGGERRIGHTGAMEPAD4_BUTTON_AGAMEPAD4_BUTTON_BGAMEPAD4_BUTTON_XGAMEPAD4_BUTTON_YGAMEPAD4_BUTTON_BACKGAMEPAD4_BUTTON_GUIDEGAMEPAD4_BUTTON_STARTGAMEPAD4_BUTTON_LEFTSTICKGAMEPAD4_BUTTON_RIGHTSTICKGAMEPAD4_BUTTON_LEFTSHOULDERGAMEPAD4_BUTTON_RIGHTSHOULDERGAMEPAD4_BUTTON_DPAD_UPGAMEPAD4_BUTTON_DPAD_DOWNGAMEPAD4_BUTTON_DPAD_LEFTGAMEPAD4_BUTTON_DPAD_RIGHT

Graphiques

variablecolors

Liste des couleurs d'affichage de la palette. Spécifiées par une valeur numérique de 24 bits. Prend en charge les opérations de liste Python.

Détails

Type

list[int]

Exemple

old_colors = list(pyxel.colors)
pyxel.colors[15] = 0x112233

variableimages

Liste des banques d'images (instances de la classe Image) (0-2).

Détails

Type

list[Image]

Exemple

pyxel.images[0].load(0, 0, "title.png")

variabletilemaps

Liste des tilemaps (instances de la classe Tilemap) (0-7).

Détails

Type

list[Tilemap]

functionclip(x, y, w, h)

Définit la zone de dessin de l'écran à partir de (x, y) avec une largeur w et une hauteur h. Appeler clip() pour réinitialiser en plein écran.

Détails

Paramètres

x (float) — Coordonnée X du coin supérieur gauche

y (float) — Coordonnée Y du coin supérieur gauche

w (float) — Largeur de la zone de découpe

h (float) — Hauteur de la zone de découpe

functionclip()

Réinitialise la zone de dessin en plein écran.

functioncamera(x, y)

Définit le décalage de dessin à (x, y). Toutes les opérations de dessin suivantes seront décalées de (-x, -y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

functioncamera()

Réinitialise le décalage de dessin à (0, 0).

functionpal(col1, col2)

Remplace la couleur col1 par col2 lors du dessin.

Détails

Paramètres

col1 (int) — Couleur à remplacer

col2 (int) — Couleur de remplacement

functionpal()

Réinitialise la palette à l'état initial.

functiondither(alpha)

Applique le tramage (pseudo-transparence) lors du dessin. Définit alpha dans la plage 0.0-1.0.

Détails

Paramètres

alpha (float) — Opacité (0.0: transparent, 1.0: opaque)

functioncls(col)

Efface l'écran avec la couleur col.

Détails

Paramètres

col (int) — Couleur

functionpget(x, y)

Obtient la couleur du pixel en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

Retour

int — Couleur du pixel

functionpset(x, y, col)

Dessine un pixel de couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

col (int) — Couleur

functionline(x1, y1, x2, y2, col)

Dessine une ligne de couleur col de (x1, y1) à (x2, y2).

Détails

Paramètres

x1 (float) — Coordonnée X de début

y1 (float) — Coordonnée Y de début

x2 (float) — Coordonnée X de fin

y2 (float) — Coordonnée Y de fin

col (int) — Couleur

functionrect(x, y, w, h, col)

Dessine un rectangle rempli de largeur w, hauteur h et couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

w (float) — Largeur

h (float) — Hauteur

col (int) — Couleur

functionrectb(x, y, w, h, col)

Dessine le contour d'un rectangle de largeur w, hauteur h et couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

w (float) — Largeur

h (float) — Hauteur

col (int) — Couleur

functioncirc(x, y, r, col)

Dessine un cercle rempli de rayon r et couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X du centre

y (float) — Coordonnée Y du centre

r (float) — Rayon

col (int) — Couleur

functioncircb(x, y, r, col)

Dessine le contour d'un cercle de rayon r et couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X du centre

y (float) — Coordonnée Y du centre

r (float) — Rayon

col (int) — Couleur

functionelli(x, y, w, h, col)

Dessine une ellipse remplie de largeur w, hauteur h et couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

w (float) — Largeur

h (float) — Hauteur

col (int) — Couleur

functionellib(x, y, w, h, col)

Dessine le contour d'une ellipse de largeur w, hauteur h et couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

w (float) — Largeur

h (float) — Hauteur

col (int) — Couleur

functiontri(x1, y1, x2, y2, x3, y3, col)

Dessine un triangle rempli avec les sommets (x1, y1), (x2, y2), (x3, y3) et la couleur col.

Détails

Paramètres

x1 (float) — X du sommet 1

y1 (float) — Y du sommet 1

x2 (float) — X du sommet 2

y2 (float) — Y du sommet 2

x3 (float) — X du sommet 3

y3 (float) — Y du sommet 3

col (int) — Couleur

functiontrib(x1, y1, x2, y2, x3, y3, col)

Dessine le contour d'un triangle avec les sommets (x1, y1), (x2, y2), (x3, y3) et la couleur col.

Détails

Paramètres

x1 (float) — X du sommet 1

y1 (float) — Y du sommet 1

x2 (float) — X du sommet 2

y2 (float) — Y du sommet 2

x3 (float) — X du sommet 3

y3 (float) — Y du sommet 3

col (int) — Couleur

functionfill(x, y, col)

Remplit la zone connectée de la même couleur que (x, y) avec la couleur col.

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

col (int) — Couleur de remplissage

functionblt(x, y, img, u, v, w, h, colkey=None, rotate=0, scale=1)

Copie la région de taille (w, h) depuis (u, v) de la banque d'images img (0-2 ou instance Image) vers (x, y). Des valeurs négatives de w/h retournent l'image. colkey définit la couleur transparente. rotate et scale appliquent des transformations.

Détails

Paramètres

x (float) — X de destination

y (float) — Y de destination

img (int/Image) — Numéro de banque d'images (0-2) ou instance Image

u (float) — X source dans la banque d'images

v (float) — Y source dans la banque d'images

w (float) — Largeur (négatif pour inverser)

h (float) — Hauteur (négatif pour inverser)

colkey (int/None) — Couleur transparente. Si omis, pas de transparence.

rotate (float) — Angle de rotation en degrés (centré sur la région de copie). Par défaut : 0.

scale (float) — Facteur d'échelle (centré sur la région de copie). Par défaut : 1.

functionbltm(x, y, tm, u, v, w, h, colkey=None, rotate=0, scale=1)

Copie la région de taille (w, h) depuis (u, v) de la tilemap tm (0-7 ou instance Tilemap) vers (x, y). Chaque tuile fait 8x8 pixels, stockée en (image_tx, image_ty). Des valeurs négatives de w/h retournent l'image. colkey définit la couleur transparente. rotate et scale appliquent des transformations.

Détails

Paramètres

x (float) — X de destination

y (float) — Y de destination

tm (int/Tilemap) — Numéro de tilemap (0-7) ou instance Tilemap

u (float) — X source dans le tilemap

v (float) — Y source dans le tilemap

w (float) — Largeur (négatif pour inverser)

h (float) — Hauteur (négatif pour inverser)

colkey (int/None) — Couleur transparente. Si omis, pas de transparence.

rotate (float) — Angle de rotation en degrés (centré sur la région de copie). Par défaut : 0.

scale (float) — Facteur d'échelle (centré sur la région de copie). Par défaut : 1.

functiontext(x, y, s, col, font=None)

Dessine une chaîne s en couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

s (str) — Chaîne à dessiner

col (int) — Couleur

font (Font) — Police personnalisée. Si omis, la police standard est utilisée.

Constantes de couleurs

COLOR_BLACKCOLOR_NAVYCOLOR_PURPLECOLOR_GREENCOLOR_BROWNCOLOR_DARK_BLUECOLOR_LIGHT_BLUECOLOR_WHITECOLOR_REDCOLOR_ORANGECOLOR_YELLOWCOLOR_LIMECOLOR_CYANCOLOR_GRAYCOLOR_PINKCOLOR_PEACH

Détails

COLOR_BLACK — 0 — Noir (#000000)

COLOR_NAVY — 1 — Bleu marine (#2b335f)

COLOR_PURPLE — 2 — Violet (#7e2072)

COLOR_GREEN — 3 — Vert (#19959c)

COLOR_BROWN — 4 — Marron (#8b4852)

COLOR_DARK_BLUE — 5 — Bleu foncé (#395c98)

COLOR_LIGHT_BLUE — 6 — Bleu clair (#a9c1ff)

COLOR_WHITE — 7 — Blanc (#eeeeee)

COLOR_RED — 8 — Rouge (#d4186c)

COLOR_ORANGE — 9 — Orange (#d38441)

COLOR_YELLOW — 10 — Jaune (#e9c35b)

COLOR_LIME — 11 — Citron vert (#70c6a9)

COLOR_CYAN — 12 — Cyan (#7696de)

COLOR_GRAY — 13 — Gris (#a3a3a3)

COLOR_PINK — 14 — Rose (#ff9798)

COLOR_PEACH — 15 — Pêche (#edc7b0)

Constantes de ressources

NUM_COLORSNUM_IMAGESIMAGE_SIZENUM_TILEMAPSTILEMAP_SIZETILE_SIZEFONT_WIDTHFONT_HEIGHT

Détails

NUM_COLORS — 16 — Nombre de couleurs de palette

NUM_IMAGES — 3 — Nombre de banques d'images (0-2)

IMAGE_SIZE — 256 — Largeur et hauteur d'image

NUM_TILEMAPS — 8 — Nombre de tilemaps (0-7)

TILEMAP_SIZE — 256 — Largeur et hauteur de la tilemap

TILE_SIZE — 8 — Taille de tuile en pixels

FONT_WIDTH — 4 — Largeur de police intégrée

FONT_HEIGHT — 6 — Hauteur de police intégrée

Audio

variablesounds

Liste des sons (instances de la classe Sound) (0-63).

Détails

Type

list[Sound]

Exemple

pyxel.sounds[0].speed = 60

variablemusics

Liste des pistes musicales (instances de la classe Music) (0-7).

Détails

Type

list[Music]

functionplay(ch, snd, sec=0, loop=False, resume=False)

Joue le son snd sur le canal ch (0-3). snd peut être un numéro de son (0-63), une liste de numéros, une instance de Sound, une liste de Sounds ou une chaîne MML.

Détails

Paramètres

ch (int) — Numéro de canal (0-3)

snd (int/list/Sound/str) — Numéro de son (0-63), liste de numéros, instance Sound, liste de Sounds ou chaîne MML

sec (float) — Position de début de lecture en secondes. Par défaut : 0.

loop (bool) — Lecture en boucle. Par défaut : False.

resume (bool) — Reprendre le son précédent après la lecture. Par défaut : False.

functionplaym(msc, sec=0, loop=False)

Joue la musique msc (0-7).

Détails

Paramètres

msc (int) — Numéro de musique (0-7)

sec (float) — Position de début de lecture en secondes. Par défaut : 0.

loop (bool) — Lecture en boucle. Par défaut : False.

functionstop(ch)

Arrête la lecture du canal spécifié ch (0-3).

Détails

Paramètres

ch (int) — Numéro de canal (0-3)

functionstop()

Arrête la lecture de tous les canaux.

functionplay_pos(ch)

Obtient la position de lecture du son du canal ch (0-3) sous forme de tuple (sound_index, sec). Renvoie None lorsque la lecture est arrêtée.

Détails

Paramètres

ch (int) — Numéro de canal (0-3)

Retour

tuple[int, float]/None — (sound_index, sec) ou None

functiongen_bgm(preset, transp, instr, seed, play=False)

Génère une liste MML de BGM à l'aide d'un algorithme. preset (0-7) sélectionne le preset, instr (0-3) sélectionne l'instrumentation.

Détails

Paramètres

preset (int) — Numéro de preset (0-7). 0-1: titre, départ (tempo moyen), 2-3: ville, paisible (tempo lent), 4-5: terrain, aventure (tempo moyen), 6-7: combat, crise (tempo rapide)

transp (int) — Transposition en demi-tons (-5 à +5).

instr (int) — Instrumentation (0-3). 0: mélodie+reverb+basse (3ch), 1: mélodie+basse+batterie (3ch), 2: mélodie+sub+basse (3ch), 3: mélodie+sub+basse+batterie (4ch).

seed (int) — Graine aléatoire

play (bool) — Lire le MML généré. Par défaut : False.

Retour

list[str] — Liste de chaînes MML

Constantes de tons et effets

Tons

TONE_TRIANGLETONE_SQUARETONE_PULSETONE_NOISE

Détails

TONE_TRIANGLE — 0 — Onde triangulaire

TONE_SQUARE — 1 — Onde carrée

TONE_PULSE — 2 — Onde pulsée

TONE_NOISE — 3 — Bruit

Effets

EFFECT_NONEEFFECT_SLIDEEFFECT_VIBRATOEFFECT_FADEOUTEFFECT_HALF_FADEOUTEFFECT_QUARTER_FADEOUT

Détails

EFFECT_NONE — 0 — Aucun effet

EFFECT_SLIDE — 1 — Glissement

EFFECT_VIBRATO — 2 — Vibrato

EFFECT_FADEOUT — 3 — Fondu sortant

EFFECT_HALF_FADEOUT — 4 — Demi-fondu

EFFECT_QUARTER_FADEOUT — 5 — Quart de fondu

Constantes de ressources

NUM_CHANNELSNUM_TONESNUM_SOUNDSNUM_MUSICS

Détails

NUM_CHANNELS — 4 — Nombre de canaux audio (0-3)

NUM_TONES — 4 — Nombre de types de ton (0-3)

NUM_SOUNDS — 64 — Nombre de sons (0-63)

NUM_MUSICS — 8 — Nombre de pistes musicales (0-7)

Mathématiques

functionceil(x)

Renvoie le plus petit entier supérieur ou égal à x.

Détails

Paramètres

x (float) — Valeur

Retour

int — Plus petit entier >= x

functionfloor(x)

Renvoie le plus grand entier inférieur ou égal à x.

Détails

Paramètres

x (float) — Valeur

Retour

int — Plus grand entier <= x

functionclamp(x, lower, upper)

Renvoie x limité entre lower et upper.

Détails

Paramètres

x (float) — Valeur à borner

lower (float) — Valeur minimale

upper (float) — Valeur maximale

Retour

float — Valeur bornée

functionsgn(x)

Renvoie 1 lorsque x est positif, 0 lorsqu'il vaut 0 et -1 lorsqu'il est négatif.

Détails

Paramètres

x (int/float) — Valeur

Retour

int/float — Signe de la valeur (1, 0 ou -1)

functionsqrt(x)

Renvoie la racine carrée de x.

Détails

Paramètres

x (float) — Valeur

Retour

float — Racine carrée de x

functionsin(deg)

Renvoie le sinus de deg degrés.

Détails

Paramètres

deg (float) — Angle en degrés

Retour

float — Valeur du sinus

functioncos(deg)

Renvoie le cosinus de deg degrés.

Détails

Paramètres

deg (float) — Angle en degrés

Retour

float — Valeur du cosinus

functionatan2(y, x)

Renvoie l'arctangente de y/x en degrés.

Détails

Paramètres

y (float) — Valeur Y

x (float) — Valeur X

Retour

float — Angle en degrés

functionrseed(seed)

Définit la graine du générateur de nombres aléatoires.

Détails

Paramètres

seed (int) — Valeur de graine (entier non négatif)

functionrndi(a, b)

Renvoie un entier aléatoire de a à b (inclus).

Détails

Paramètres

a (int) — Valeur minimale (incluse)

b (int) — Valeur maximale (incluse)

Retour

int — Nombre entier aléatoire de a à b

functionrndf(a, b)

Renvoie un nombre à virgule flottante aléatoire de a à b (inclus).

Détails

Paramètres

a (float) — Valeur minimale (incluse)

b (float) — Valeur maximale (incluse)

Retour

float — Nombre décimal aléatoire de a à b

functionnseed(seed)

Définit la graine du bruit de Perlin.

Détails

Paramètres

seed (int) — Valeur de graine (entier non négatif)

functionnoise(x, y=0, z=0)

Renvoie la valeur du bruit de Perlin pour les coordonnées spécifiées.

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y. Par défaut : 0.

z (float) — Coordonnée Z. Par défaut : 0.

Retour

float — Valeur de bruit Perlin

Classe Image

variableImage.width

La largeur de l'image.

Détails

Type

int

variableImage.height

La hauteur de l'image.

Détails

Type

int

functionImage.set(x, y, data)

Définit l'image à (x, y) à l'aide d'une liste de chaînes hexadécimales. Chaque caractère représente un indice de couleur (0-f).

Détails

Paramètres

x (int) — Coordonnée X

y (int) — Coordonnée Y

data (list[str]) — Données d'image sous forme de liste de chaînes

Exemple

pyxel.images[0].set(10, 10, ["0123", "4567", "89ab", "cdef"])

functionImage.load(x, y, filename, include_colors=False)

Charge un fichier image (PNG/GIF/JPEG) en (x, y).

Détails

Paramètres

x (int) — Coordonnée X

y (int) — Coordonnée Y

filename (str) — Nom du fichier image (PNG/GIF/JPEG)

include_colors (bool) — Inclure les couleurs de palette du fichier. Par défaut : False.

functionImage.pget(x, y)

Obtient la couleur du pixel en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

Retour

int — Couleur du pixel

functionImage.pset(x, y, col)

Dessine un pixel de couleur col en (x, y).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

col (int) — Couleur

function

Image.{cls, line, rect, rectb, circ, circb, elli, ellib, tri, trib, fill, blt, bltm, blt3d, bltm3d, text, clip, camera, pal, dither}

Les instances d'Image prennent en charge toutes les fonctions de dessin de la section Graphiques. Elles fonctionnent de la même manière mais dessinent sur l'image au lieu de l'écran.

Classe Tilemap

variableTilemap.width

La largeur de la tilemap.

Détails

Type

int

variableTilemap.height

La hauteur de la tilemap.

Détails

Type

int

variableTilemap.imgsrc

La banque d'images (0-2) ou l'instance Image référencée par la tilemap.

Détails

Type

int/Image

functionTilemap.set(x, y, data)

Définit la tilemap à (x, y) à l'aide d'une liste de chaînes. Chaque tuile est une valeur hexadécimale à 4 chiffres représentant (image_tx, image_ty), séparées par des espaces.

Détails

Paramètres

x (int) — Coordonnée X

y (int) — Coordonnée Y

data (list[str]) — Données de tilemap sous forme de liste de chaînes

Exemple

pyxel.tilemaps[0].set(0, 0, ["0000 0100 a0b0", "0001 0101 a1b1"])

functionTilemap.load(x, y, filename, layer)

Charge le calque layer (0-) du fichier TMX en (x, y).

Détails

Paramètres

x (int) — Coordonnée X

y (int) — Coordonnée Y

filename (str) — Nom du fichier TMX

layer (int) — Numéro de couche (0-)

functionTilemap.pget(x, y)

Obtient le tile en (x, y). Un tile est un tuple de (image_tx, image_ty).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

Retour

tuple[int, int] — (image_tx, image_ty)

functionTilemap.pset(x, y, tile)

Définit un tile en (x, y). Un tile est un tuple de (image_tx, image_ty).

Détails

Paramètres

x (float) — Coordonnée X

y (float) — Coordonnée Y

tile (tuple[int, int]) — Tuile en (image_tx, image_ty)

functionTilemap.{cls, line, rect, rectb, circ, circb, elli, ellib, tri, trib, fill, blt, clip, camera}

Les instances de Tilemap prennent en charge les fonctions de dessin de la section Graphiques. Elles fonctionnent de la même manière mais dessinent des tiles sur la tilemap au lieu de pixels sur l'écran. Utilisez un tuple de tile (image_tx, image_ty) au lieu d'une valeur de couleur.

functionTilemap.collide(x, y, w, h, dx, dy, walls)

Résout les collisions après application du mouvement en pixels (dx, dy) au rectangle en pixels à (x, y) de taille (w, h), et renvoie le (dx, dy) ajusté. walls est une liste de coordonnées de tuiles faisant office d'obstacles.

Détails

Paramètres

x (float) — Position X du rectangle

y (float) — Position Y du rectangle

w (float) — Largeur du rectangle

h (float) — Hauteur du rectangle

dx (float) — Déplacement en X

dy (float) — Déplacement en Y

walls (list[tuple[int, int]]) — Liste de tuiles de mur (image_tx, image_ty)

Retour

tuple[float, float] — (dx, dy) ajusté

Classe Sound

variableSound.notes

Liste des notes (0-59). Les valeurs plus élevées produisent des sons plus aigus. 33 = 'A2' (440 Hz). Les silences sont -1.

Détails

Type

list[int]

variableSound.tones

Liste des timbres (0: Triangle, 1: Square, 2: Pulse, 3: Noise).

Détails

Type

list[int]

variableSound.volumes

Liste des volumes (0-7).

Détails

Type

list[int]

variableSound.effects

Liste des effets (0: None, 1: Slide, 2: Vibrato, 3: FadeOut, 4: Half-FadeOut, 5: Quarter-FadeOut).

Détails

Type

list[int]

variableSound.speed

Vitesse de lecture. 1 est le plus rapide, et plus le nombre est grand, plus la lecture est lente. À 120, une note équivaut à 1 seconde.

Détails

Type

int

functionSound.set(notes, tones, volumes, effects, speed)

Définit les notes, les timbres, les volumes et les effets à l'aide de chaînes. Si la chaîne des timbres, des volumes ou des effets est plus courte que les notes, elle se répète depuis le début.

Détails

Paramètres

notes (str) — Chaîne de notes

tones (str) — Chaîne de timbres

volumes (str) — Chaîne de volumes

effects (str) — Chaîne d'effets

speed (int) — Vitesse de lecture

functionSound.set_notes(notes)

Définit les notes à l'aide d'une chaîne composée de noms de notes (CDEFGAB), dièse (#) ou bémol (-) optionnels, octave (0-4) et silences (R). Insensible à la casse, les espaces sont ignorés.

Détails

Paramètres

notes (str) — Chaîne notes

Exemple

pyxel.sounds[0].set_notes("g2b-2d3r rf3f3f3")

functionSound.set_tones(tones)

Définit les timbres avec une chaîne de TSPN (ou 0-9 pour des numéros de timbre personnalisés). Insensible à la casse, les espaces sont ignorés.

Détails

Paramètres

tones (str) — Chaîne tones

Exemple

pyxel.sounds[0].set_tones("ttss pppn")

functionSound.set_volumes(volumes)

Définit les volumes avec une chaîne de 01234567. Les espaces sont ignorés.

Détails

Paramètres

volumes (str) — Chaîne volumes

Exemple

pyxel.sounds[0].set_volumes("7777 7531")

functionSound.set_effects(effects)

Définit les effets avec une chaîne de NSVFHQ. Insensible à la casse, les espaces sont ignorés.

Détails

Paramètres

effects (str) — Chaîne effects

Exemple

pyxel.sounds[0].set_effects("nfnf nvvs")

functionSound.mml(code)

Passe en mode MML avec la chaîne MML donnée. En mode MML, les paramètres normaux tels que les notes et la vitesse sont ignorés. Pour les commandes MML disponibles, consultez la page Commandes MML de Pyxel.

Détails

Paramètres

code (str) — Chaîne MML

Exemple

pyxel.sounds[0].mml("T120 Q90 @1 V100 O5 L8 C4&C<G16R16>C.")

functionSound.mml()

Quitte le mode MML et revient au mode normal.

functionSound.pcm(filename)

Charge un fichier audio (WAV/OGG) pour la lecture.

Détails

Paramètres

filename (str) — Nom du fichier audio (WAV/OGG)

Exemple

pyxel.sounds[0].pcm("sounds/bgm.ogg")

functionSound.pcm()

Quitte le mode PCM et revient au mode normal.

Classe Music

variableMusic.seqs

Une liste bidimensionnelle de sons (0-63) sur plusieurs canaux.

Détails

Type

list[list[int]]

functionMusic.set(seq0, seq1, seq2, ...)

Définit les listes de sons (0-63) pour chaque canal. Une liste vide signifie que le canal n'est pas utilisé.

Détails

Paramètres

seq0, seq1, ... (list[int]) — Listes de sons par canal. Liste vide = non utilisé.

Exemple

pyxel.musics[0].set([0, 1], [], [3])

Référence API de Pyxel

Système

Ressource

Entrée

Graphiques

Audio

Mathématiques

Classe Font

Classe Image

Classe Tilemap

Classe Sound

Classe Music

Classe Channel

Classe Tone