Skip to content

API Docs

Frankie A edited this page Sep 11, 2021 · 3 revisions

Muzzle API Docs

ive once again changed where the docs are written in, you can find the new docs here. a Read the Docs version will be coming soon :))

Last Updated: September 11th, 2021

[value] - Default Value

* - Additional Information available at the end of the section

!MACRO - This means the macro is not defined. Example: A macro used in a ifdef

Muzzle.h

Description: Main Header File

Functions


void QuitMuzzle(Applet applet);

Description: Quits Muzzle and cleans resources.

Returns: Nothing

Includes


core/Applet.h: Muzzle API

View docs here

windows.h*: Windows API

View docs here

core/vector.h: Muzzle API

View docs here

core/Drawing.h: Muzzle API

View docs here

core/tint.h: Muzzle API

View docs here

core/Sprite.h: Muzzle API

View docs here

shapes/Rectangle.h: Muzzle API

View docs here

shapes/Circle.h: Muzzle API

View docs here

core/Text.h: Muzzle API

View docs here

core/Input.h: Muzzle API

View docs here

stdlib.h: LibC

View docs here

MuzzleMath.h

Description: Includes Math-Related Macros

Macros


  • PI (3.14159)
  • DEG2RAD (PI / 180)
  • RAD2DEG (180 / PI)

Additional Information


*windows.h - Only if _WIN32 is defined

backend.h

Description: Includes important libraries and macros for Muzzle to work.

Macros


  • GLFW_INCLUDE_ES2*
  • MAX_BUFFERS ([4] or 8*)
  • BUFFER_LENGTH ([1024] or 2048*)
  • !MUZZLE_ALLOW_BUFFER_HIGH
  • MUZZLE_FALSE (0)
  • MUZZLE_TRUE (1)

Types


MUZZLE_WINDOW: typedef GLFWwindow* MUZZLE_WINDOW

Includes


glfw3.h: GLFW

View Docs Here

Additional Information


*2048 - Only if MUZZLE_ALLOW_BUFFER_HIGH is defined

*8 - Only if MUZZLE_ALLOW_BUFFER_HIGH is defined

*GLFW_INCLUDE_ES2 - Only if __EMSCRIPTEN__ is defined

Core

Description: Core Header Files

Applet.h

Animation.h

callback.h

Drawing.h

Error.h

Input.h

Loop.h

Sprite.h

Text.h

tint.h

vector.h

Shapes

Circle.h

Rectangle.h