diff options
Diffstat (limited to 'API.md')
| -rw-r--r-- | API.md | 559 |
1 files changed, 443 insertions, 116 deletions
@@ -31,9 +31,151 @@ This function can be used for custom log message handling. --- -## Globals - Keys +## Globals - ConfigFlags -KEY_ENTER +FLAG_VSYNC_HINT + +FLAG_FULLSCREEN_MODE + +FLAG_WINDOW_RESIZABLE + +FLAG_WINDOW_UNDECORATED + +FLAG_WINDOW_HIDDEN + +FLAG_WINDOW_MINIMIZED + +FLAG_WINDOW_MAXIMIZED + +FLAG_WINDOW_UNFOCUSED + +FLAG_WINDOW_TOPMOST + +FLAG_WINDOW_ALWAYS_RUN + +FLAG_WINDOW_TRANSPARENT + +FLAG_WINDOW_HIGHDPI + +FLAG_MSAA_4X_HINT + +FLAG_INTERLACED_HINT + +## Globals - TraceLogLevel + +LOG_ALL + +LOG_TRACE + +LOG_DEBUG + +LOG_INFO + +LOG_WARNING + +LOG_ERROR + +LOG_FATAL + +LOG_NONE + +## Globals - KeyboardKey + +KEY_NULL + +KEY_APOSTROPHE + +KEY_COMMA + +KEY_MINUS + +KEY_PERIOD + +KEY_SLASH + +KEY_ZERO + +KEY_ONE + +KEY_TWO + +KEY_THREE + +KEY_FOUR + +KEY_FIVE + +KEY_SIX + +KEY_SEVEN + +KEY_EIGHT + +KEY_NINE + +KEY_SEMICOLON + +KEY_EQUAL + +KEY_A + +KEY_B + +KEY_C + +KEY_D + +KEY_E + +KEY_F + +KEY_G + +KEY_H + +KEY_I + +KEY_J + +KEY_K + +KEY_L + +KEY_M + +KEY_N + +KEY_O + +KEY_P + +KEY_Q + +KEY_R + +KEY_S + +KEY_T + +KEY_U + +KEY_V + +KEY_W + +KEY_X + +KEY_Y + +KEY_Z + +KEY_LEFT_BRACKET + +KEY_BACKSLASH + +KEY_RIGHT_BRACKET + +KEY_GRAVE KEY_SPACE @@ -57,147 +199,227 @@ KEY_DOWN KEY_UP -## Globals - WindowFlags +KEY_PAGE_UP -FLAG_VSYNC_HINT +KEY_PAGE_DOWN -FLAG_FULLSCREEN_MODE +KEY_HOME -FLAG_WINDOW_RESIZABLE +KEY_END -FLAG_WINDOW_UNDECORATED +KEY_CAPS_LOCK -FLAG_WINDOW_HIDDEN +KEY_SCROLL_LOCK -FLAG_WINDOW_MINIMIZED +KEY_NUM_LOCK -FLAG_WINDOW_MAXIMIZED +KEY_PRINT_SCREEN -FLAG_WINDOW_UNFOCUSED +KEY_PAUSE -FLAG_WINDOW_TOPMOST +KEY_F1 -FLAG_WINDOW_ALWAYS_RUN +KEY_F2 -FLAG_WINDOW_TRANSPARENT +KEY_F3 -FLAG_WINDOW_HIGHDPI +KEY_F4 -FLAG_MSAA_4X_HINT +KEY_F5 -FLAG_INTERLACED_HINT +KEY_F6 -## Globals - BlendModes +KEY_F7 -BLEND_ALPHA +KEY_F8 -BLEND_ADDITIVE +KEY_F9 -BLEND_MULTIPLIED +KEY_F10 -BLEND_ADD_COLORS +KEY_F11 -BLEND_SUBTRACT_COLORS +KEY_F12 -BLEND_CUSTOM +KEY_LEFT_SHIFT -## Globals - TextureModes +KEY_LEFT_CONTROL -TEXTURE_SOURCE_TEXTURE +KEY_LEFT_ALT -TEXTURE_SOURCE_RENDER_TEXTURE +KEY_LEFT_SUPER -## Globals - CameraProjections +KEY_RIGHT_SHIFT -CAMERA_PERSPECTIVE +KEY_RIGHT_CONTROL -CAMERA_ORTHOGRAPHIC +KEY_RIGHT_ALT -## Globals - CameraMode +KEY_RIGHT_SUPER -CAMERA_CUSTOM +KEY_KB_MENU -CAMERA_FREE +KEY_KP_0 -CAMERA_ORBITAL +KEY_KP_1 -CAMERA_FIRST_PERSON +KEY_KP_2 -CAMERA_THIRD_PERSON +KEY_KP_3 -## Globals - MapTypes +KEY_KP_4 -MATERIAL_MAP_ALBEDO +KEY_KP_5 -MATERIAL_MAP_METALNESS +KEY_KP_6 -MATERIAL_MAP_NORMAL +KEY_KP_7 -MATERIAL_MAP_ROUGHNESS +KEY_KP_8 -MATERIAL_MAP_OCCLUSION +KEY_KP_9 -MATERIAL_MAP_EMISSION +KEY_KP_DECIMAL -MATERIAL_MAP_HEIGHT +KEY_KP_DIVIDE -MATERIAL_MAP_CUBEMAP +KEY_KP_MULTIPLY -MATERIAL_MAP_IRRADIANCE +KEY_KP_SUBTRACT -MATERIAL_MAP_PREFILTER +KEY_KP_ADD -MATERIAL_MAP_BRDF +KEY_KP_ENTER -## Globals - TextureFilters +KEY_KP_EQUAL -TEXTURE_FILTER_POINT +KEY_BACK -TEXTURE_FILTER_BILINEAR +KEY_MENU -TEXTURE_FILTER_TRILINEAR +KEY_VOLUME_UP -TEXTURE_FILTER_ANISOTROPIC_4X +KEY_VOLUME_DOWN -TEXTURE_FILTER_ANISOTROPIC_8X +## Globals - MouseButtons -TEXTURE_FILTER_ANISOTROPIC_16X +MOUSE_BUTTON_LEFT -## Globals - TextureWrapModes +MOUSE_BUTTON_RIGHT -TEXTURE_WRAP_REPEAT +MOUSE_BUTTON_MIDDLE -TEXTURE_WRAP_CLAMP +MOUSE_BUTTON_SIDE -TEXTURE_WRAP_MIRROR_REPEAT +MOUSE_BUTTON_EXTRA -TEXTURE_WRAP_MIRROR_CLAMP +MOUSE_BUTTON_FORWARD -## Globals - TraceLogLevel +MOUSE_BUTTON_BACK -LOG_ALL +## Globals - MouseCursor -LOG_TRACE +MOUSE_CURSOR_DEFAULT -LOG_DEBUG +MOUSE_CURSOR_ARROW -LOG_INFO +MOUSE_CURSOR_IBEAM -LOG_WARNING +MOUSE_CURSOR_CROSSHAIR -LOG_ERROR +MOUSE_CURSOR_POINTING_HAND -LOG_FATAL +MOUSE_CURSOR_RESIZE_EW -LOG_NONE +MOUSE_CURSOR_RESIZE_NS -## Globals - N-patchLayout +MOUSE_CURSOR_RESIZE_NWSE -NPATCH_NINE_PATCH +MOUSE_CURSOR_RESIZE_NESW -NPATCH_THREE_PATCH_VERTICAL +MOUSE_CURSOR_RESIZE_ALL -NPATCH_THREE_PATCH_HORIZONTAL +MOUSE_CURSOR_NOT_ALLOWED + +## Globals - GamepadButtons + +GAMEPAD_BUTTON_UNKNOWN + +GAMEPAD_BUTTON_LEFT_FACE_UP + +GAMEPAD_BUTTON_LEFT_FACE_RIGHT + +GAMEPAD_BUTTON_LEFT_FACE_DOWN + +GAMEPAD_BUTTON_LEFT_FACE_LEFT + +GAMEPAD_BUTTON_RIGHT_FACE_UP + +GAMEPAD_BUTTON_RIGHT_FACE_RIGHT + +GAMEPAD_BUTTON_RIGHT_FACE_DOWN + +GAMEPAD_BUTTON_RIGHT_FACE_LEFT + +GAMEPAD_BUTTON_LEFT_TRIGGER_1 + +GAMEPAD_BUTTON_LEFT_TRIGGER_2 + +GAMEPAD_BUTTON_RIGHT_TRIGGER_1 + +GAMEPAD_BUTTON_RIGHT_TRIGGER_2 + +GAMEPAD_BUTTON_MIDDLE_LEFT + +GAMEPAD_BUTTON_MIDDLE + +GAMEPAD_BUTTON_MIDDLE_RIGHT + +GAMEPAD_BUTTON_LEFT_THUMB + +GAMEPAD_BUTTON_RIGHT_THUMB + +## Globals - GamepadAxis + +GAMEPAD_AXIS_LEFT_X + +GAMEPAD_AXIS_LEFT_Y + +GAMEPAD_AXIS_RIGHT_X + +GAMEPAD_AXIS_RIGHT_Y + +GAMEPAD_AXIS_LEFT_TRIGGER + +GAMEPAD_AXIS_RIGHT_TRIGGER + +## Globals - MapTypes + +MATERIAL_MAP_ALBEDO + +MATERIAL_MAP_METALNESS + +MATERIAL_MAP_NORMAL + +MATERIAL_MAP_ROUGHNESS + +MATERIAL_MAP_OCCLUSION + +MATERIAL_MAP_EMISSION + +MATERIAL_MAP_HEIGHT + +MATERIAL_MAP_CUBEMAP + +MATERIAL_MAP_IRRADIANCE + +MATERIAL_MAP_PREFILTER + +MATERIAL_MAP_BRDF + +MATERIAL_MAP_DIFFUSE + +MATERIAL_MAP_SPECULAR ## Globals - ShaderLocationIndex @@ -253,6 +475,10 @@ SHADER_LOC_MAP_PREFILTER SHADER_LOC_MAP_BRDF +SHADER_LOC_MAP_DIFFUSE + +SHADER_LOC_MAP_SPECULAR + ## Globals - ShaderUniformDataType SHADER_UNIFORM_FLOAT @@ -283,30 +509,6 @@ SHADER_ATTRIB_VEC3 SHADER_ATTRIB_VEC4 -## Globals - Gesture - -GESTURE_NONE - -GESTURE_TAP - -GESTURE_DOUBLETAP - -GESTURE_HOLD - -GESTURE_DRAG - -GESTURE_SWIPE_RIGHT - -GESTURE_SWIPE_LEFT - -GESTURE_SWIPE_UP - -GESTURE_SWIPE_DOWN - -GESTURE_PINCH_IN - -GESTURE_PINCH_OUT - ## Globals - PixelFormats PIXELFORMAT_UNCOMPRESSED_GRAYSCALE @@ -351,6 +553,122 @@ PIXELFORMAT_COMPRESSED_ASTC_4x4_RGBA PIXELFORMAT_COMPRESSED_ASTC_8x8_RGBA +## Globals - TextureFilters + +TEXTURE_FILTER_POINT + +TEXTURE_FILTER_BILINEAR + +TEXTURE_FILTER_TRILINEAR + +TEXTURE_FILTER_ANISOTROPIC_4X + +TEXTURE_FILTER_ANISOTROPIC_8X + +TEXTURE_FILTER_ANISOTROPIC_16X + +## Globals - TextureWrap + +TEXTURE_WRAP_REPEAT + +TEXTURE_WRAP_CLAMP + +TEXTURE_WRAP_MIRROR_REPEAT + +TEXTURE_WRAP_MIRROR_CLAMP + +## Globals - CubemapLayout + +CUBEMAP_LAYOUT_AUTO_DETECT + +CUBEMAP_LAYOUT_LINE_VERTICAL + +CUBEMAP_LAYOUT_LINE_HORIZONTAL + +CUBEMAP_LAYOUT_CROSS_THREE_BY_FOUR + +CUBEMAP_LAYOUT_CROSS_FOUR_BY_THREE + +CUBEMAP_LAYOUT_PANORAMA + +## Globals - FontType + +FONT_DEFAULT + +FONT_BITMAP + +FONT_SDF + +## Globals - BlendModes + +BLEND_ALPHA + +BLEND_ADDITIVE + +BLEND_MULTIPLIED + +BLEND_ADD_COLORS + +BLEND_SUBTRACT_COLORS + +BLEND_CUSTOM + +## Globals - Gesture + +GESTURE_NONE + +GESTURE_TAP + +GESTURE_DOUBLETAP + +GESTURE_HOLD + +GESTURE_DRAG + +GESTURE_SWIPE_RIGHT + +GESTURE_SWIPE_LEFT + +GESTURE_SWIPE_UP + +GESTURE_SWIPE_DOWN + +GESTURE_PINCH_IN + +GESTURE_PINCH_OUT + +## Globals - CameraMode + +CAMERA_CUSTOM + +CAMERA_FREE + +CAMERA_ORBITAL + +CAMERA_FIRST_PERSON + +CAMERA_THIRD_PERSON + +## Globals - CameraProjections + +CAMERA_PERSPECTIVE + +CAMERA_ORTHOGRAPHIC + +## Globals - N-patchLayout + +NPATCH_NINE_PATCH + +NPATCH_THREE_PATCH_VERTICAL + +NPATCH_THREE_PATCH_HORIZONTAL + +## Globals - TextureModes + +TEXTURE_SOURCE_TEXTURE + +TEXTURE_SOURCE_RENDER_TEXTURE + ## Globals - Colors WHITE @@ -395,7 +713,7 @@ GUI_TEXT_ALIGN_CENTER GUI_TEXT_ALIGN_RIGHT -## Globals - GuiControls +## Globals - GuiControl DEFAULT @@ -487,6 +805,20 @@ SLIDER_PADDING PROGRESS_PADDING +## Globals - GuiScrollBarProperty + +ARROWS_SIZE + +ARROWS_VISIBLE + +SCROLL_SLIDER_PADDING + +SCROLL_SLIDER_SIZE + +SCROLL_PADDING + +SCROLL_SPEED + ## Globals - GuiCheckBoxProperty CHECK_PADDING @@ -515,20 +847,6 @@ SPIN_BUTTON_WIDTH SPIN_BUTTON_SPACING -## Globals - GuiScrollBarProperty - -ARROWS_SIZE - -ARROWS_VISIBLE - -SCROLL_SLIDER_PADDING - -SCROLL_SLIDER_SIZE - -SCROLL_PADDING - -SCROLL_SPEED - ## Globals - GuiListViewProperty LIST_ITEMS_HEIGHT @@ -2641,12 +2959,12 @@ Load texture from image data --- -> success = RL_UnloadTexture( Texture2D texture ) +> texture = RL_LoadTextureCubemap( Image image, int layout ) -Unload texture from GPU memory ( VRAM ) +Load cubemap from image, multiple image cubemap layouts supported -- Failure return false -- Success return true +- Failure return -1 +- Success return int --- @@ -2659,6 +2977,15 @@ Load texture for rendering ( framebuffer ) --- +> success = RL_UnloadTexture( Texture2D texture ) + +Unload texture from GPU memory ( VRAM ) + +- Failure return false +- Success return true + +--- + > success = RL_UnloadRenderTexture( RenderTexture2D target ) Unload render texture from GPU memory ( VRAM ) |