Re-exported predicates

The following predicates are exported from this file while their implementation is defined in imported modules or non-module files loaded by this module.

 sdl_pollevent(-Event:dict) is semidet

Poll the next pending event. Succeeds once with a dict for each pending event, and fails when the queue is empty.

Event is a dict whose tag is the event type and which always contains the keys type and timestamp. Additional type-specific keys are present depending on the tag:

• quit -- no extra keys
• mousemotion -- windowID, which, state, x, y, xrel, yrel
• mousebutton -- windowID, which, button, state, clicks, x, y
• keyboard -- windowID, state, repeat, keysym Only the event types handled by the binding are produced. % @see https://wiki.libsdl.org/SDL3/SDL_PollEvent

 img_load(+File:string, -Surface:blob) is det

Load an image file into a surface blob. File is the path to an image; the resulting format is auto-detected.

See also

- https://wiki.libsdl.org/SDL_image/IMG_Load

Undocumented predicates

The following predicates are exported, but not or incorrectly documented.

 sdl_init(Arg1)

 sdl_init_flag(Arg1, Arg2)

 sdl_quit

 sdl_quit

 sdl_createwindow(Arg1, Arg2, Arg3, Arg4, Arg5)

 sdl_setwindowposition(Arg1, Arg2, Arg3)

 sdl_destroywindow(Arg1)

 sdl_window_flag(Arg1, Arg2)

 sdl_windowpos(Arg1, Arg2)

 sdl_destroywindow(Arg1)

 sdl_createrenderer(Arg1, Arg2, Arg3)

 sdl_setrendervsync(Arg1, Arg2)

 sdl_destroyrenderer(Arg1)

 sdl_renderclear(Arg1)

 sdl_rendertexture(Arg1, Arg2, Arg3, Arg4)

 sdl_renderpresent(Arg1)

 sdl_createtexturefromsurface(Arg1, Arg2, Arg3)

 sdl_createtexture(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 sdl_destroytexture(Arg1)

 sdl_setrenderdrawcolor(Arg1, Arg2, Arg3, Arg4, Arg5)

 sdl_renderrect(Arg1, Arg2)

 sdl_renderfillrect(Arg1, Arg2)

 sdl_updatetexture(Arg1, Arg2, Arg3, Arg4)

 sdl_locktexture(Arg1, Arg2, Arg3, Arg4)

 sdl_unlocktexture(Arg1)

 sdl_texture_access(Arg1, Arg2)

 sdl_destroyrenderer(Arg1)

 sdl_renderclear(Arg1)

 sdl_renderpresent(Arg1)

 sdl_destroytexture(Arg1)

 sdl_destroysurface(Arg1)

 sdl_createsurfacefrom(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 sdl_destroysurface(Arg1)

 sdl_pixel_format(Arg1, Arg2)

 sdl_creategpudevice(Arg1, Arg2, Arg3, Arg4)

 sdl_destroygpudevice(Arg1)

 sdl_claimwindowforgpudevice(Arg1, Arg2)

 sdl_releasewindowfromgpudevice(Arg1, Arg2)

 sdl_acquiregpucommandbuffer(Arg1, Arg2)

 sdl_submitgpucommandbuffer(Arg1)

 sdl_cancelgpucommandbuffer(Arg1)

 sdl_acquiregpuswapchaintexture(Arg1, Arg2, Arg3, Arg4, Arg5)

 sdl_waitandacquiregpuswapchaintexture(Arg1, Arg2, Arg3, Arg4, Arg5)

 sdl_begingpurenderpass(Arg1, Arg2, Arg3, Arg4)

 sdl_endgpurenderpass(Arg1)

 sdl_creategputexture(Arg1, Arg2, Arg3)

 sdl_releasegputexture(Arg1)

 sdl_creategpushader(Arg1, Arg2, Arg3)

 sdl_releasegpushader(Arg1)

 sdl_creategpugraphicspipeline(Arg1, Arg2, Arg3)

 sdl_releasegpugraphicspipeline(Arg1)

 sdl_creategpubuffer(Arg1, Arg2, Arg3, Arg4)

 sdl_releasegpubuffer(Arg1)

 sdl_creategputransferbuffer(Arg1, Arg2, Arg3, Arg4)

 sdl_releasegputransferbuffer(Arg1)

 sdl_mapgputransferbuffer(Arg1, Arg2, Arg3)

 sdl_unmapgputransferbuffer(Arg1)

 sdl_begingpucopypass(Arg1, Arg2)

 sdl_endgpucopypass(Arg1)

 sdl_uploadtogpubuffer(Arg1, Arg2, Arg3, Arg4)

 sdl_bindgpugraphicspipeline(Arg1, Arg2)

 sdl_bindgpuvertexbuffers(Arg1, Arg2, Arg3)

 sdl_bindgpuindexbuffer(Arg1, Arg2, Arg3)

 sdl_drawgpuindexedprimitives(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)

 sdl_drawgpuprimitives(Arg1, Arg2, Arg3, Arg4, Arg5)

 sdl_gpu_index_element_size(Arg1, Arg2)

 sdl_gpu_buffer_usage(Arg1, Arg2)

 sdl_gpu_transfer_buffer_usage(Arg1, Arg2)

 sdl_gpu_load_op(Arg1, Arg2)

 sdl_gpu_store_op(Arg1, Arg2)

 sdl_gpu_texture_type(Arg1, Arg2)

 sdl_gpu_texture_format(Arg1, Arg2)

 sdl_gpu_texture_usage(Arg1, Arg2)

 sdl_gpu_sample_count(Arg1, Arg2)

 sdl_gpu_shader_format(Arg1, Arg2)

 sdl_gpu_shader_stage(Arg1, Arg2)

 sdl_gpu_primitive_type(Arg1, Arg2)

 sdl_gpu_fill_mode(Arg1, Arg2)

 sdl_gpu_cull_mode(Arg1, Arg2)

 sdl_gpu_front_face(Arg1, Arg2)

 sdl_gpu_compare_op(Arg1, Arg2)

 sdl_gpu_stencil_op(Arg1, Arg2)

 sdl_gpu_blend_op(Arg1, Arg2)

 sdl_gpu_blend_factor(Arg1, Arg2)

 sdl_gpu_vertex_input_rate(Arg1, Arg2)

 sdl_gpu_vertex_element_format(Arg1, Arg2)

 sdl_gpu_color_component(Arg1, Arg2)

 sdl_getnumgpudrivers(Arg1)

 sdl_getgpudriver(Arg1, Arg2)

 make_color_target(Arg1, Arg2)

 default_color_target(Arg1)

 is_color_target(Arg1)

 make_depth_stencil_target(Arg1, Arg2)

 default_depth_stencil_target(Arg1)

 is_depth_stencil_target(Arg1)

 make_gpu_texture_create_info(Arg1, Arg2)

 default_gpu_texture_create_info(Arg1)

 is_gpu_texture_create_info(Arg1)

 make_gpu_shader_create_info(Arg1, Arg2)

 default_gpu_shader_create_info(Arg1)

 is_gpu_shader_create_info(Arg1)

 make_vertex_buffer_description(Arg1, Arg2)

 default_vertex_buffer_description(Arg1)

 is_vertex_buffer_description(Arg1)

 make_vertex_attribute(Arg1, Arg2)

 default_vertex_attribute(Arg1)

 is_vertex_attribute(Arg1)

 make_stencil_op_state(Arg1, Arg2)

 default_stencil_op_state(Arg1)

 is_stencil_op_state(Arg1)

 make_color_target_blend_state(Arg1, Arg2)

 default_color_target_blend_state(Arg1)

 is_color_target_blend_state(Arg1)

 make_color_target_description(Arg1, Arg2)

 default_color_target_description(Arg1)

 is_color_target_description(Arg1)

 make_vertex_input_state(Arg1, Arg2)

 default_vertex_input_state(Arg1)

 is_vertex_input_state(Arg1)

 make_rasterizer_state(Arg1, Arg2)

 default_rasterizer_state(Arg1)

 is_rasterizer_state(Arg1)

 make_multisample_state(Arg1, Arg2)

 default_multisample_state(Arg1)

 is_multisample_state(Arg1)

 make_depth_stencil_state(Arg1, Arg2)

 default_depth_stencil_state(Arg1)

 is_depth_stencil_state(Arg1)

 make_target_info(Arg1, Arg2)

 default_target_info(Arg1)

 is_target_info(Arg1)

 make_gpu_graphics_pipeline_create_info(Arg1, Arg2)

 default_gpu_graphics_pipeline_create_info(Arg1)

 is_gpu_graphics_pipeline_create_info(Arg1)

 make_buffer_binding(Arg1, Arg2)

 default_buffer_binding(Arg1)

 is_buffer_binding(Arg1)

 make_transfer_buffer_location(Arg1, Arg2)

 default_transfer_buffer_location(Arg1)

 is_transfer_buffer_location(Arg1)

 make_buffer_region(Arg1, Arg2)

 default_buffer_region(Arg1)

 is_buffer_region(Arg1)

 sdl_getnumgpudrivers(Arg1)

 sdl_getgpudriver(Arg1, Arg2)