sdl3/sdl
library
Functions
sdlAbs (int x → int
stdinc
Compute the absolute value of x.
sdlAcos (double x → double
stdinc
Compute the arc cosine of x.
sdlAcosf (double x → double
stdinc
Compute the arc cosine of x.
sdlAcquireCameraFrame (Pointer <SdlCamera camera , Pointer <Uint64 timestampNs → Pointer <SdlSurface
camera
Acquire a frame.
sdlAcquireGpuCommandBuffer (Pointer <SdlGpuDevice device → Pointer <SdlGpuCommandBuffer
gpu
Acquire a command buffer.
sdlAcquireGpuSwapchainTexture (Pointer <SdlGpuCommandBuffer commandBuffer , Pointer <SdlWindow window , Pointer <Pointer <SdlGpuTexture swapchainTexture , Pointer <Uint32 swapchainTextureWidth , Pointer <Uint32 swapchainTextureHeight → bool
gpu
Acquire a texture to use in presentation.
sdlAddAtomicInt (Pointer <SdlAtomicInt a , int v → int
atomic
Add to an atomic variable.
sdlAddAtomicU32 (Pointer <SdlAtomicU32 a , int v → int
atomic
Add to an atomic variable.
sdlAddEventWatch (Pointer <NativeFunction <SdlEventFilter filter , Pointer <NativeType userdata → bool
events
Add a callback to be triggered when an event is added to the event queue.
sdlAddGamepadMapping (String ?mapping → int
gamepad
Add support for gamepads that SDL is unaware of or change the binding of an
existing gamepad.
sdlAddGamepadMappingsFromFile (String ?file → int
gamepad
Load a set of gamepad mappings from a file.
sdlAddGamepadMappingsFromIo (Pointer <SdlIoStream src , bool closeio → int
gamepad
Load a set of gamepad mappings from an SDL_IOStream.
sdlAddHintCallback (String ?name , Pointer <NativeFunction <SdlHintCallback callback , Pointer <NativeType userdata → bool
hints
Add a function to watch a particular hint.
sdlAddSurfaceAlternateImage (Pointer <SdlSurface surface , Pointer <SdlSurface image → bool
surface
Add an alternate version of a surface.
sdlAddTimer (int interval , Pointer <NativeFunction <SdlTimerCallback callback , Pointer <NativeType userdata → int
timer
Call a callback function at a future time.
sdlAddTimerNs (int interval , Pointer <NativeFunction <SdlNsTimerCallback callback , Pointer <NativeType userdata → int
timer
Call a callback function at a future time.
sdlAddVulkanRenderSemaphores (Pointer <SdlRenderer renderer , int waitStageMask , int waitSemaphore , int signalSemaphore → bool
render
Add a set of synchronization semaphores for the current frame.
sdlAlignedAlloc (int alignment , int size → Pointer <NativeType
stdinc
Allocate memory aligned to a specific alignment.
sdlAlignedFree (Pointer <NativeType mem → void
stdinc
Free memory allocated by SDL_aligned_alloc().
sdlAsin (double x → double
stdinc
Compute the arc sine of x.
sdlAsinf (double x → double
stdinc
Compute the arc sine of x.
sdlAsprintf (Pointer <Pointer <Int8 strp , String ?fmt → int
stdinc
This works exactly like asprintf() but doesn't require access to a C
runtime.
sdlAsyncIoFromFile (String ?file , String ?mode → Pointer <SdlAsyncIo
asyncio
Use this function to create a new SDL_AsyncIO object for reading from
and/or writing to a named file.
sdlAtan (double x → double
stdinc
Compute the arc tangent of x.
sdlAtan2 (double y , double x → double
stdinc
Compute the arc tangent of y / x, using the signs of x and y to adjust
the result's quadrant.
sdlAtan2f (double y , double x → double
stdinc
Compute the arc tangent of y / x, using the signs of x and y to adjust
the result's quadrant.
sdlAtanf (double x → double
stdinc
Compute the arc tangent of x.
sdlAtof (String ?str → double
stdinc
Parse a double from a string.
sdlAtoi (String ?str → int
stdinc
Parse an int from a string.
sdlAttachVirtualJoystick (Pointer <SdlVirtualJoystickDesc desc → int
joystick
Attach a new virtual joystick.
sdlAudioDevicePaused (int devid → bool
audio
Use this function to query if an audio device is paused.
sdlAudioStreamDevicePaused (Pointer <SdlAudioStream stream → bool
audio
Use this function to query if an audio device associated with a stream is
paused.
sdlBeginGpuComputePass (Pointer <SdlGpuCommandBuffer commandBuffer , Pointer <SdlGpuStorageTextureReadWriteBinding storageTextureBindings , int numStorageTextureBindings , Pointer <SdlGpuStorageBufferReadWriteBinding storageBufferBindings , int numStorageBufferBindings → Pointer <SdlGpuComputePass
gpu
Begins a compute pass on a command buffer.
sdlBeginGpuCopyPass (Pointer <SdlGpuCommandBuffer commandBuffer → Pointer <SdlGpuCopyPass
gpu
Begins a copy pass on a command buffer.
sdlBeginGpuRenderPass (Pointer <SdlGpuCommandBuffer commandBuffer , Pointer <SdlGpuColorTargetInfo colorTargetInfos , int numColorTargets , Pointer <SdlGpuDepthStencilTargetInfo depthStencilTargetInfo → Pointer <SdlGpuRenderPass
gpu
Begins a render pass on a command buffer.
sdlBindAudioStream (int devid , Pointer <SdlAudioStream stream → bool
audio
Bind a single audio stream to an audio device.
sdlBindAudioStreams (int devid , Pointer <Pointer <SdlAudioStream streams , int numStreams → bool
audio
Bind a list of audio streams to an audio device.
sdlBindGpuComputePipeline (Pointer <SdlGpuComputePass computePass , Pointer <SdlGpuComputePipeline computePipeline → void
gpu
Binds a compute pipeline on a command buffer for use in compute dispatch.
sdlBindGpuComputeSamplers (Pointer <SdlGpuComputePass computePass , int firstSlot , Pointer <SdlGpuTextureSamplerBinding textureSamplerBindings , int numBindings → void
gpu
Binds texture-sampler pairs for use on the compute shader.
sdlBindGpuComputeStorageBuffers (Pointer <SdlGpuComputePass computePass , int firstSlot , Pointer <Pointer <SdlGpuBuffer storageBuffers , int numBindings → void
gpu
Binds storage buffers as readonly for use on the compute pipeline.
sdlBindGpuComputeStorageTextures (Pointer <SdlGpuComputePass computePass , int firstSlot , Pointer <Pointer <SdlGpuTexture storageTextures , int numBindings → void
gpu
Binds storage textures as readonly for use on the compute pipeline.
sdlBindGpuFragmentSamplers (Pointer <SdlGpuRenderPass renderPass , int firstSlot , Pointer <SdlGpuTextureSamplerBinding textureSamplerBindings , int numBindings → void
gpu
Binds texture-sampler pairs for use on the fragment shader.
sdlBindGpuFragmentStorageBuffers (Pointer <SdlGpuRenderPass renderPass , int firstSlot , Pointer <Pointer <SdlGpuBuffer storageBuffers , int numBindings → void
gpu
Binds storage buffers for use on the fragment shader.
sdlBindGpuFragmentStorageTextures (Pointer <SdlGpuRenderPass renderPass , int firstSlot , Pointer <Pointer <SdlGpuTexture storageTextures , int numBindings → void
gpu
Binds storage textures for use on the fragment shader.
sdlBindGpuGraphicsPipeline (Pointer <SdlGpuRenderPass renderPass , Pointer <SdlGpuGraphicsPipeline graphicsPipeline → void
gpu
Binds a graphics pipeline on a render pass to be used in rendering.
sdlBindGpuIndexBuffer (Pointer <SdlGpuRenderPass renderPass , Pointer <SdlGpuBufferBinding binding , int indexElementSize → void
gpu
Binds an index buffer on a command buffer for use with subsequent draw
calls.
sdlBindGpuVertexBuffers (Pointer <SdlGpuRenderPass renderPass , int firstSlot , Pointer <SdlGpuBufferBinding bindings , int numBindings → void
gpu
Binds vertex buffers on a command buffer for use with subsequent draw
calls.
sdlBindGpuVertexSamplers (Pointer <SdlGpuRenderPass renderPass , int firstSlot , Pointer <SdlGpuTextureSamplerBinding textureSamplerBindings , int numBindings → void
gpu
Binds texture-sampler pairs for use on the vertex shader.
sdlBindGpuVertexStorageBuffers (Pointer <SdlGpuRenderPass renderPass , int firstSlot , Pointer <Pointer <SdlGpuBuffer storageBuffers , int numBindings → void
gpu
Binds storage buffers for use on the vertex shader.
sdlBindGpuVertexStorageTextures (Pointer <SdlGpuRenderPass renderPass , int firstSlot , Pointer <Pointer <SdlGpuTexture storageTextures , int numBindings → void
gpu
Binds storage textures for use on the vertex shader.
sdlBlitGpuTexture (Pointer <SdlGpuCommandBuffer commandBuffer , Pointer <SdlGpuBlitInfo info → void
gpu
Blits from a source texture region to a destination texture region.
sdlBlitSurface (Pointer <SdlSurface src , Pointer <SdlRect srcrect , Pointer <SdlSurface dst , Pointer <SdlRect dstrect → bool
surface
Performs a fast blit from the source surface to the destination surface
with clipping.
sdlBlitSurface9Grid (Pointer <SdlSurface src , Pointer <SdlRect srcrect , int leftWidth , int rightWidth , int topHeight , int bottomHeight , double scale , int scaleMode , Pointer <SdlSurface dst , Pointer <SdlRect dstrect → bool
surface
Perform a scaled blit using the 9-grid algorithm to a destination surface,
which may be of a different format.
sdlBlitSurfaceScaled (Pointer <SdlSurface src , Pointer <SdlRect srcrect , Pointer <SdlSurface dst , Pointer <SdlRect dstrect , int scaleMode → bool
surface
Perform a scaled blit to a destination surface, which may be of a different
format.
sdlBlitSurfaceTiled (Pointer <SdlSurface src , Pointer <SdlRect srcrect , Pointer <SdlSurface dst , Pointer <SdlRect dstrect → bool
surface
Perform a tiled blit to a destination surface, which may be of a different
format.
sdlBlitSurfaceTiledWithScale (Pointer <SdlSurface src , Pointer <SdlRect srcrect , double scale , int scaleMode , Pointer <SdlSurface dst , Pointer <SdlRect dstrect → bool
surface
Perform a scaled and tiled blit to a destination surface, which may be of a
different format.
sdlBlitSurfaceUnchecked (Pointer <SdlSurface src , Pointer <SdlRect srcrect , Pointer <SdlSurface dst , Pointer <SdlRect dstrect → bool
surface
Perform low-level surface blitting only.
sdlBlitSurfaceUncheckedScaled (Pointer <SdlSurface src , Pointer <SdlRect srcrect , Pointer <SdlSurface dst , Pointer <SdlRect dstrect , int scaleMode → bool
surface
Perform low-level surface scaled blitting only.
sdlBroadcastCondition (Pointer <SdlCondition cond → void
mutex
Restart all threads that are waiting on the condition variable.
sdlBsearch (Pointer <NativeType key , Pointer <NativeType base , int nmemb , int size , Pointer <NativeFunction <SdlCompareCallback compare → Pointer <NativeType
stdinc
Perform a binary search on a previously sorted array.
sdlBsearchR (Pointer <NativeType key , Pointer <NativeType base , int nmemb , int size , Pointer <NativeFunction <SdlCompareCallbackR compare , Pointer <NativeType userdata → Pointer <NativeType
stdinc
Perform a binary search on a previously sorted array, passing a userdata
pointer to the compare function.
sdlButton (int x → int
/const SDLK_AUDIONEXT = SDL_SCANCODE_AUDIONEXT | SDLK_SCANCODE_MASK;
/const SDLK_AUDIOPREV = SDL_SCANCODE_AUDIOPREV | SDLK_SCANCODE_MASK;
/const SDLK_AUDIOSTOP = SDL_SCANCODE_AUDIOSTOP | SDLK_SCANCODE_MASK;
/const SDLK_AUDIOPLAY = SDL_SCANCODE_AUDIOPLAY | SDLK_SCANCODE_MASK;
/const SDLK_AUDIOMUTE = SDL_SCANCODE_AUDIOMUTE | SDLK_SCANCODE_MASK;
/const SDLK_MEDIASELECT = SDL_SCANCODE_MEDIASELECT | SDLK_SCANCODE_MASK;
/const SDLK_WWW = SDL_SCANCODE_WWW | SDLK_SCANCODE_MASK;
/const SDLK_MAIL = SDL_SCANCODE_MAIL | SDLK_SCANCODE_MASK;
/const SDLK_CALCULATOR = SDL_SCANCODE_CALCULATOR | SDLK_SCANCODE_MASK;
/const SDLK_COMPUTER = SDL_SCANCODE_COMPUTER | SDLK_SCANCODE_MASK;
sdlCalculateGpuTextureFormatSize (int format , int width , int height , int depthOrLayerCount → int
gpu
Calculate the size in bytes of a texture format with dimensions.
sdlCancelGpuCommandBuffer (Pointer <SdlGpuCommandBuffer commandBuffer → bool
gpu
Cancels a command buffer.
sdlCaptureMouse (bool enabled → bool
mouse
Capture the mouse and to track input outside an SDL window.
sdlCeil (double x → double
stdinc
Compute the ceiling of x.
sdlCeilf (double x → double
stdinc
Compute the ceiling of x.
sdlClaimWindowForGpuDevice (Pointer <SdlGpuDevice device , Pointer <SdlWindow window → bool
gpu
Claims a window, creating a swapchain structure for it.
sdlCleanupTls ()
→ void
thread
Cleanup all TLS data for this thread.
sdlClearAudioStream (Pointer <SdlAudioStream stream → bool
audio
Clear any pending data in the stream.
sdlClearClipboardData ()
→ bool
clipboard
Clear the clipboard data.
sdlClearComposition (Pointer <SdlWindow window → bool
keyboard
Dismiss the composition window/IME without disabling the subsystem.
sdlClearError ()
→ bool
error
Clear any previous error message for this thread.
sdlClearProperty (int props , String ?name → bool
properties
Clear a property from a group of properties.
sdlClearSurface (Pointer <SdlSurface surface , double r , double g , double b , double a → bool
surface
Clear a surface with a specific color, with floating point precision.
sdlClickTrayEntry (Pointer <SdlTrayEntry entry → void
tray
Simulate a click on a tray entry.
sdlCloseAsyncIo (Pointer <SdlAsyncIo asyncio , bool flush , Pointer <SdlAsyncIoQueue queue , Pointer <NativeType userdata → bool
asyncio
Close and free any allocated resources for an async I/O object.
sdlCloseAudioDevice (int devid → void
audio
Close a previously-opened audio device.
sdlCloseCamera (Pointer <SdlCamera camera → void
camera
Use this function to shut down camera processing and close the camera
device.
sdlCloseGamepad (Pointer <SdlGamepad gamepad → void
gamepad
Close a gamepad previously opened with SDL_OpenGamepad().
sdlCloseHaptic (Pointer <SdlHaptic haptic → void
haptic
Close a haptic device previously opened with SDL_OpenHaptic().
sdlCloseIo (Pointer <SdlIoStream context → bool
iostream
Close and free an allocated SDL_IOStream structure.
sdlCloseJoystick (Pointer <SdlJoystick joystick → void
joystick
Close a joystick previously opened with SDL_OpenJoystick().
sdlCloseSensor (Pointer <SdlSensor sensor → void
sensor
Close a sensor previously opened with SDL_OpenSensor().
sdlCloseStorage (Pointer <SdlStorage storage → bool
storage
Closes and frees a storage container.
sdlCompareAndSwapAtomicInt (Pointer <SdlAtomicInt a , int oldval , int newval → bool
atomic
Set an atomic variable to a new value if it is currently an old value.
sdlCompareAndSwapAtomicPointer (Pointer <Pointer <NativeType a , Pointer <NativeType oldval , Pointer <NativeType newval → bool
atomic
Set a pointer to a new value if it is currently an old value.
sdlCompareAndSwapAtomicU32 (Pointer <SdlAtomicU32 a , int oldval , int newval → bool
atomic
Set an atomic variable to a new value if it is currently an old value.
sdlComposeCustomBlendMode (int srcColorFactor , int dstColorFactor , int colorOperation , int srcAlphaFactor , int dstAlphaFactor , int alphaOperation → int
blendmode
Compose a custom blend mode for renderers.
sdlConvertAudioSamples (Pointer <SdlAudioSpec srcSpec , Pointer <Uint8 srcData , int srcLen , Pointer <SdlAudioSpec dstSpec , Pointer <Pointer <Uint8 dstData , Pointer <Int32 dstLen → bool
audio
Convert some audio data of one format to another format.
sdlConvertEventToRenderCoordinates (Pointer <SdlRenderer renderer , Pointer <SdlEvent event → bool
render
Convert the coordinates in an event to render coordinates.
sdlConvertPixels (int width , int height , int srcFormat , Pointer <NativeType src , int srcPitch , int dstFormat , Pointer <NativeType dst , int dstPitch → bool
surface
Copy a block of pixels of one format to another format.
sdlConvertPixelsAndColorspace (int width , int height , int srcFormat , int srcColorspace , int srcProperties , Pointer <NativeType src , int srcPitch , int dstFormat , int dstColorspace , int dstProperties , Pointer <NativeType dst , int dstPitch → bool
surface
Copy a block of pixels of one format and colorspace to another format and
colorspace.
sdlConvertSurface (Pointer <SdlSurface surface , int format → Pointer <SdlSurface
surface
Copy an existing surface to a new surface of the specified format.
sdlConvertSurfaceAndColorspace (Pointer <SdlSurface surface , int format , Pointer <SdlPalette palette , int colorspace , int props → Pointer <SdlSurface
surface
Copy an existing surface to a new surface of the specified format and
colorspace.
sdlCopyFile (String ?oldpath , String ?newpath → bool
filesystem
Copy a file.
sdlCopyGpuBufferToBuffer (Pointer <SdlGpuCopyPass copyPass , Pointer <SdlGpuBufferLocation source , Pointer <SdlGpuBufferLocation destination , int size , bool cycle → void
gpu
Performs a buffer-to-buffer copy.
sdlCopyGpuTextureToTexture (Pointer <SdlGpuCopyPass copyPass , Pointer <SdlGpuTextureLocation source , Pointer <SdlGpuTextureLocation destination , int w , int h , int d , bool cycle → void
gpu
Performs a texture-to-texture copy.
sdlCopyProperties (int src , int dst → bool
properties
Copy a group of properties.
sdlCopysign (double x , double y → double
stdinc
Copy the sign of one floating-point value to another.
sdlCopysignf (double x , double y → double
stdinc
Copy the sign of one floating-point value to another.
sdlCopyStorageFile (Pointer <SdlStorage storage , String ?oldpath , String ?newpath → bool
storage
Copy a file in a writable storage container.
sdlCos (double x → double
stdinc
Compute the cosine of x.
sdlCosf (double x → double
stdinc
Compute the cosine of x.
sdlCrc16 (int crc , Pointer <NativeType data , int len → int
stdinc
Calculate a CRC-16 value.
sdlCrc32 (int crc , Pointer <NativeType data , int len → int
stdinc
Calculate a CRC-32 value.
sdlCreateAsyncIoQueue ()
→ Pointer <SdlAsyncIoQueue
asyncio
Create a task queue for tracking multiple I/O operations.
sdlCreateAudioStream (Pointer <SdlAudioSpec srcSpec , Pointer <SdlAudioSpec dstSpec → Pointer <SdlAudioStream
audio
Create a new audio stream.
sdlCreateColorCursor (Pointer <SdlSurface surface , int hotX , int hotY → Pointer <SdlCursor
mouse
Create a color cursor.
sdlCreateCondition ()
→ Pointer <SdlCondition
mutex
Create a condition variable.
sdlCreateCursor (Pointer <Uint8 data , Pointer <Uint8 mask , int w , int h , int hotX , int hotY → Pointer <SdlCursor
mouse
Create a cursor using the specified bitmap data and mask (in MSB format).
sdlCreateDirectory (String ?path → bool
filesystem
Create a directory, and any missing parent directories.
sdlCreateEnvironment (bool populated → Pointer <SdlEnvironment
stdinc
Create a set of environment variables
sdlCreateGpuBuffer (Pointer <SdlGpuDevice device , Pointer <SdlGpuBufferCreateInfo createinfo → Pointer <SdlGpuBuffer
gpu
Creates a buffer object to be used in graphics or compute workflows.
sdlCreateGpuComputePipeline (Pointer <SdlGpuDevice device , Pointer <SdlGpuComputePipelineCreateInfo createinfo → Pointer <SdlGpuComputePipeline
gpu
Creates a pipeline object to be used in a compute workflow.
sdlCreateGpuDevice (int formatFlags , bool debugMode , String ?name → Pointer <SdlGpuDevice
gpu
Creates a GPU context.
sdlCreateGpuDeviceWithProperties (int props → Pointer <SdlGpuDevice
gpu
Creates a GPU context.
sdlCreateGpuGraphicsPipeline (Pointer <SdlGpuDevice device , Pointer <SdlGpuGraphicsPipelineCreateInfo createinfo → Pointer <SdlGpuGraphicsPipeline
gpu
Creates a pipeline object to be used in a graphics workflow.
sdlCreateGpuRenderer (Pointer <SdlWindow window , int formatFlags , Pointer <Pointer <SdlGpuDevice device → Pointer <SdlRenderer
render
Create a 2D GPU rendering context for a window, with support for the
specified shader format.
sdlCreateGpuRenderState (Pointer <SdlRenderer renderer , Pointer <SdlGpuRenderStateCreateInfo createinfo → Pointer <SdlGpuRenderState
render
Create custom GPU render state.
sdlCreateGpuSampler (Pointer <SdlGpuDevice device , Pointer <SdlGpuSamplerCreateInfo createinfo → Pointer <SdlGpuSampler
gpu
Creates a sampler object to be used when binding textures in a graphics
workflow.
sdlCreateGpuShader (Pointer <SdlGpuDevice device , Pointer <SdlGpuShaderCreateInfo createinfo → Pointer <SdlGpuShader
gpu
Creates a shader to be used when creating a graphics pipeline.
sdlCreateGpuTexture (Pointer <SdlGpuDevice device , Pointer <SdlGpuTextureCreateInfo createinfo → Pointer <SdlGpuTexture
gpu
Creates a texture object to be used in graphics or compute workflows.
sdlCreateGpuTransferBuffer (Pointer <SdlGpuDevice device , Pointer <SdlGpuTransferBufferCreateInfo createinfo → Pointer <SdlGpuTransferBuffer
gpu
Creates a transfer buffer to be used when uploading to or downloading from
graphics resources.
sdlCreateHapticEffect (Pointer <SdlHaptic haptic , Pointer <SdlHapticEffect effect → int
haptic
Create a new haptic effect on a specified device.
sdlCreateMutex ()
→ Pointer <SdlMutex
mutex
Create a new mutex.
sdlCreatePalette (int ncolors → Pointer <SdlPalette
pixels
Create a palette structure with the specified number of color entries.
Create a child popup window of the specified parent window.
sdlCreateProcess (Pointer <Pointer <Int8 args , bool pipeStdio → Pointer <SdlProcess
process
Create a new process.
sdlCreateProcessWithProperties (int props → Pointer <SdlProcess
process
Create a new process with the specified properties.
sdlCreateProperties ()
→ int
properties
Create a group of properties.
sdlCreateRenderer (Pointer <SdlWindow window , String ?name → Pointer <SdlRenderer
render
Create a 2D rendering context for a window.
sdlCreateRendererWithProperties (int props → Pointer <SdlRenderer
render
Create a 2D rendering context for a window, with the specified properties.
sdlCreateRwLock ()
→ Pointer <SdlRwLock
mutex
Create a new read/write lock.
sdlCreateSemaphore (int initialValue → Pointer <SdlSemaphore
mutex
Create a semaphore.
sdlCreateSoftwareRenderer (Pointer <SdlSurface surface → Pointer <SdlRenderer
render
Create a 2D software rendering context for a surface.
sdlCreateStorageDirectory (Pointer <SdlStorage storage , String ?path → bool
storage
Create a directory in a writable storage container.
sdlCreateSurface (int width , int height , int format → Pointer <SdlSurface
surface
Allocate a new surface with a specific pixel format.
sdlCreateSurfaceFrom (int width , int height , int format , Pointer <NativeType pixels , int pitch → Pointer <SdlSurface
surface
Allocate a new surface with a specific pixel format and existing pixel
data.
sdlCreateSurfacePalette (Pointer <SdlSurface surface → Pointer <SdlPalette
surface
Create a palette and associate it with a surface.
sdlCreateSystemCursor (int id → Pointer <SdlCursor
mouse
Create a system cursor.
sdlCreateTexture (Pointer <SdlRenderer renderer , int format , int access , int w , int h → Pointer <SdlTexture
render
Create a texture for a rendering context.
sdlCreateTextureFromSurface (Pointer <SdlRenderer renderer , Pointer <SdlSurface surface → Pointer <SdlTexture
render
Create a texture from an existing surface.
sdlCreateTextureWithProperties (Pointer <SdlRenderer renderer , int props → Pointer <SdlTexture
render
Create a texture for a rendering context with the specified properties.
sdlCreateThread (Pointer <NativeFunction <SdlThreadFunction fn , String ?name , Pointer <NativeType data → Pointer <SdlThread
thread
Create a new thread with a default stack size.
sdlCreateThreadRuntime (Pointer <NativeFunction <SdlThreadFunction fn , String ?name , Pointer <NativeType data , Pointer <NativeType pfnBeginThread , Pointer <NativeType pfnEndThread → Pointer <SdlThread
thread
The actual entry point for SDL_CreateThread.
sdlCreateThreadWithProperties (int props → Pointer <SdlThread
thread
Create a new thread with with the specified properties.
sdlCreateThreadWithPropertiesRuntime (int props , Pointer <NativeType pfnBeginThread , Pointer <NativeType pfnEndThread → Pointer <SdlThread
thread
The actual entry point for SDL_CreateThreadWithProperties.
sdlCreateTray (Pointer <SdlSurface icon , String ?tooltip → Pointer <SdlTray
tray
Create an icon to be placed in the operating system's tray, or equivalent.
Create a menu for a system tray.
Create a submenu for a system tray entry.
sdlCreateWindow (String ?title , int w , int h , int flags → Pointer <SdlWindow
video
Create a window with the specified dimensions and flags.
sdlCreateWindowAndRenderer (String ?title , int width , int height , int windowFlags , Pointer <Pointer <SdlWindow window , Pointer <Pointer <SdlRenderer renderer → bool
render
Create a window and default renderer.
sdlCreateWindowWithProperties (int props → Pointer <SdlWindow
video
Create a window with the specified properties.
sdlCursorVisible ()
→ bool
mouse
Return whether the cursor is currently being shown.
sdlDateTimeToTime (Pointer <SdlDateTime dt , Pointer <Int64 ticks → bool
time
Converts a calendar time to an SDL_Time in nanoseconds since the epoch.
sdlDefinePixcelFormat (int type , int order , int layout , int bits , int bytes → int
sdlDelay (int ms → void
timer
Wait a specified number of milliseconds before returning.
sdlDelayNs (int ns → void
timer
Wait a specified number of nanoseconds before returning.
sdlDelayPrecise (int ns → void
timer
Wait a specified number of nanoseconds before returning.
sdlDestroyAsyncIoQueue (Pointer <SdlAsyncIoQueue queue → void
asyncio
Destroy a previously-created async I/O task queue.
sdlDestroyAudioStream (Pointer <SdlAudioStream stream → void
audio
Free an audio stream.
sdlDestroyCondition (Pointer <SdlCondition cond → void
mutex
Destroy a condition variable.
sdlDestroyCursor (Pointer <SdlCursor cursor → void
mouse
Free a previously-created cursor.
sdlDestroyEnvironment (Pointer <SdlEnvironment env → void
stdinc
Destroy a set of environment variables.
sdlDestroyGpuDevice (Pointer <SdlGpuDevice device → void
gpu
Destroys a GPU context previously returned by SDL_CreateGPUDevice.
sdlDestroyGpuRenderState (Pointer <SdlGpuRenderState state → void
render
Destroy custom GPU render state.
sdlDestroyHapticEffect (Pointer <SdlHaptic haptic , int effect → void
haptic
Destroy a haptic effect on the device.
sdlDestroyMutex (Pointer <SdlMutex mutex → void
mutex
Destroy a mutex created with SDL_CreateMutex().
sdlDestroyPalette (Pointer <SdlPalette palette → void
pixels
Free a palette created with SDL_CreatePalette().
sdlDestroyProcess (Pointer <SdlProcess process → void
process
Destroy a previously created process object.
sdlDestroyProperties (int props → void
properties
Destroy a group of properties.
sdlDestroyRenderer (Pointer <SdlRenderer renderer → void
render
Destroy the rendering context for a window and free all associated
textures.
sdlDestroyRwLock (Pointer <SdlRwLock rwlock → void
mutex
Destroy a read/write lock created with SDL_CreateRWLock().
sdlDestroySemaphore (Pointer <SdlSemaphore sem → void
mutex
Destroy a semaphore.
sdlDestroySurface (Pointer <SdlSurface surface → void
surface
Free a surface.
sdlDestroyTexture (Pointer <SdlTexture texture → void
render
Destroy the specified texture.
sdlDestroyTray (Pointer <SdlTray tray → void
tray
Destroys a tray object.
sdlDestroyWindow (Pointer <SdlWindow window → void
video
Destroy a window.
sdlDestroyWindowSurface (Pointer <SdlWindow window → bool
video
Destroy the surface associated with the window.
sdlDetachThread (Pointer <SdlThread thread → void
thread
Let a thread clean up on exit without intervention.
sdlDetachVirtualJoystick (int instanceId → bool
joystick
Detach a virtual joystick.
sdlDisableScreenSaver ()
→ bool
video
Prevent the screen from being blanked by a screen saver.
sdlDispatchGpuCompute (Pointer <SdlGpuComputePass computePass , int groupcountX , int groupcountY , int groupcountZ → void
gpu
Dispatches compute work.
sdlDispatchGpuComputeIndirect (Pointer <SdlGpuComputePass computePass , Pointer <SdlGpuBuffer buffer , int offset → void
gpu
Dispatches compute work with parameters set from a buffer.
sdlDownloadFromGpuBuffer (Pointer <SdlGpuCopyPass copyPass , Pointer <SdlGpuBufferRegion source , Pointer <SdlGpuTransferBufferLocation destination → void
gpu
Copies data from a buffer to a transfer buffer on the GPU timeline.
sdlDownloadFromGpuTexture (Pointer <SdlGpuCopyPass copyPass , Pointer <SdlGpuTextureRegion source , Pointer <SdlGpuTextureTransferInfo destination → void
gpu
Copies data from a texture to a transfer buffer on the GPU timeline.
sdlDrawGpuIndexedPrimitives (Pointer <SdlGpuRenderPass renderPass , int numIndices , int numInstances , int firstIndex , int vertexOffset , int firstInstance → void
gpu
Draws data using bound graphics state with an index buffer and instancing
enabled.
sdlDrawGpuIndexedPrimitivesIndirect (Pointer <SdlGpuRenderPass renderPass , Pointer <SdlGpuBuffer buffer , int offset , int drawCount → void
gpu
Draws data using bound graphics state with an index buffer enabled and with
draw parameters set from a buffer.
sdlDrawGpuPrimitives (Pointer <SdlGpuRenderPass renderPass , int numVertices , int numInstances , int firstVertex , int firstInstance → void
gpu
Draws data using bound graphics state.
sdlDrawGpuPrimitivesIndirect (Pointer <SdlGpuRenderPass renderPass , Pointer <SdlGpuBuffer buffer , int offset , int drawCount → void
gpu
Draws data using bound graphics state and with draw parameters set from a
buffer.
sdlDuplicateSurface (Pointer <SdlSurface surface → Pointer <SdlSurface
surface
Creates a new surface identical to the existing surface.
sdlEglGetCurrentConfig ()
→ Pointer <NativeType
video
Get the currently active EGL config.
sdlEglGetCurrentDisplay ()
→ Pointer <NativeType
video
Get the currently active EGL display.
sdlEglGetProcAddress (String ?proc → Pointer <NativeType
video
Get an EGL library function by name.
sdlEglGetWindowSurface (Pointer <SdlWindow window → void
video
Get the EGL surface associated with the window.
sdlEglSetAttributeCallbacks (Pointer <NativeFunction <SdlEglAttribArrayCallback platformAttribCallback , Pointer <NativeFunction <SdlEglIntArrayCallback surfaceAttribCallback , Pointer <NativeFunction <SdlEglIntArrayCallback contextAttribCallback , Pointer <NativeType userdata → void
video
Sets the callbacks for defining custom EGLAttrib arrays for EGL
initialization.
sdlEnableScreenSaver ()
→ bool
video
Allow the screen to be blanked by a screen saver.
sdlEndGpuComputePass (Pointer <SdlGpuComputePass computePass → void
gpu
Ends the current compute pass.
sdlEndGpuCopyPass (Pointer <SdlGpuCopyPass copyPass → void
gpu
Ends the current copy pass.
sdlEndGpuRenderPass (Pointer <SdlGpuRenderPass renderPass → void
gpu
Ends the given render pass.
sdlEnterAppMainCallbacks (int argc , Pointer <Pointer <Int8 argv , Pointer <NativeFunction <SdlAppInitFunc appinit , Pointer <NativeFunction <SdlAppIterateFunc appiter , Pointer <NativeFunction <SdlAppEventFunc appevent , Pointer <NativeFunction <SdlAppQuitFunc appquit → int
main
An entry point for SDL's use in SDL_MAIN_USE_CALLBACKS.
sdlEnumerateDirectory (String ?path , Pointer <NativeFunction <SdlEnumerateDirectoryCallback callback , Pointer <NativeType userdata → bool
filesystem
Enumerate a directory through a callback function.
sdlEnumerateProperties (int props , Pointer <NativeFunction <SdlEnumeratePropertiesCallback callback , Pointer <NativeType userdata → bool
properties
Enumerate the properties contained in a group of properties.
sdlEnumerateStorageDirectory (Pointer <SdlStorage storage , String ?path , Pointer <NativeFunction <SdlEnumerateDirectoryCallback callback , Pointer <NativeType userdata → bool
storage
Enumerate a directory in a storage container through a callback function.
sdlEventEnabled (int type → bool
events
Query the state of processing events by type.
sdlExp (double x → double
stdinc
Compute the exponential of x.
sdlExpf (double x → double
stdinc
Compute the exponential of x.
sdlFabs (double x → double
stdinc
Compute the absolute value of x
sdlFabsf (double x → double
stdinc
Compute the absolute value of x
sdlFillSurfaceRect (Pointer <SdlSurface dst , Pointer <SdlRect rect , int color → bool
surface
Perform a fast fill of a rectangle with a specific color.
sdlFillSurfaceRects (Pointer <SdlSurface dst , Pointer <SdlRect rects , int count , int color → bool
surface
Perform a fast fill of a set of rectangles with a specific color.
sdlFilterEvents (Pointer <NativeFunction <SdlEventFilter filter , Pointer <NativeType userdata → void
events
Run a specific filter function on the current event queue, removing any
events for which the filter returns false.
sdlFlashWindow (Pointer <SdlWindow window , int operation → bool
video
Request a window to demand attention from the user.
sdlFlipSurface (Pointer <SdlSurface surface , int flip → bool
surface
Flip a surface vertically or horizontally.
sdlFloor (double x → double
stdinc
Compute the floor of x.
sdlFloorf (double x → double
stdinc
Compute the floor of x.
sdlFlushAudioStream (Pointer <SdlAudioStream stream → bool
audio
Tell the stream that you're done sending data, and anything being buffered
should be converted/resampled and made available immediately.
sdlFlushEvent (int type → void
events
Clear events of a specific type from the event queue.
sdlFlushEvents (int minType , int maxType → void
events
Clear events of a range of types from the event queue.
sdlFlushIo (Pointer <SdlIoStream context → bool
iostream
Flush any buffered data in the stream.
sdlFlushRenderer (Pointer <SdlRenderer renderer → bool
render
Force the rendering context to flush any pending commands and state.
sdlFmod (double x , double y → double
stdinc
Return the floating-point remainder of x / y
sdlFmodf (double x , double y → double
stdinc
Return the floating-point remainder of x / y
sdlFree (Pointer <NativeType mem → void
stdinc
Free allocated memory.
sdlGamepadConnected (Pointer <SdlGamepad gamepad → bool
gamepad
Check if a gamepad has been opened and is currently connected.
sdlGamepadEventsEnabled ()
→ bool
gamepad
Query the state of gamepad event processing.
sdlGamepadHasAxis (Pointer <SdlGamepad gamepad , int axis → bool
gamepad
Query whether a gamepad has a given axis.
sdlGamepadHasButton (Pointer <SdlGamepad gamepad , int button → bool
gamepad
Query whether a gamepad has a given button.
sdlGamepadHasSensor (Pointer <SdlGamepad gamepad , int type → bool
gamepad
Return whether a gamepad has a particular sensor.
sdlGamepadSensorEnabled (Pointer <SdlGamepad gamepad , int type → bool
gamepad
Query whether sensor data reporting is enabled for a gamepad.
sdlGdkResumeGpu (Pointer <SdlGpuDevice device → void
gpu
Call this to resume GPU operation on Xbox when you receive the
SDL_EVENT_WILL_ENTER_FOREGROUND event.
sdlGdkSuspendComplete ()
→ void
main
Callback from the application to let the suspend continue.
sdlGdkSuspendGpu (Pointer <SdlGpuDevice device → void
gpu
Call this to suspend GPU operation on Xbox when you receive the
SDL_EVENT_DID_ENTER_BACKGROUND event.
sdlGenerateMipmapsForGpuTexture (Pointer <SdlGpuCommandBuffer commandBuffer , Pointer <SdlGpuTexture texture → void
gpu
Generates mipmaps for the given texture.
sdlGetAndroidActivity ()
→ Pointer <NativeType
system
Retrieve the Java instance of the Android activity class.
sdlGetAndroidCachePath ()
→ String ?
system
Get the path used for caching data for this Android application.
sdlGetAndroidExternalStoragePath ()
→ String ?
system
Get the path used for external storage for this Android application.
sdlGetAndroidExternalStorageState ()
→ int
system
Get the current state of external storage for this Android application.
sdlGetAndroidInternalStoragePath ()
→ String ?
system
Get the path used for internal storage for this Android application.
sdlGetAndroidJniEnv ()
→ Pointer <NativeType
system
Get the Android Java Native Interface Environment of the current thread.
sdlGetAndroidSdkVersion ()
→ int
system
Query Android API level of the current device.
sdlGetAppMetadataProperty (String ?name → String ?
init
Get metadata about your app.
sdlGetAssertionHandler (Pointer <Pointer <NativeType puserdata → Pointer <NativeFunction <SdlAssertionHandler
assert
Get the current assertion handler.
sdlGetAssertionReport ()
→ Pointer <SdlAssertData
assert
Get a list of all assertion failures.
sdlGetAsyncIoResult (Pointer <SdlAsyncIoQueue queue , Pointer <SdlAsyncIoOutcome outcome → bool
asyncio
Query an async I/O task queue for completed tasks.
sdlGetAsyncIoSize (Pointer <SdlAsyncIo asyncio → int
asyncio
Use this function to get the size of the data stream in an SDL_AsyncIO.
sdlGetAtomicInt (Pointer <SdlAtomicInt a → int
atomic
Get the value of an atomic variable.
sdlGetAtomicPointer (Pointer <Pointer <NativeType a → Pointer <NativeType
atomic
Get the value of a pointer atomically.
sdlGetAtomicU32 (Pointer <SdlAtomicU32 a → int
atomic
Get the value of an atomic variable.
sdlGetAudioDeviceChannelMap (int devid , Pointer <Int32 count → Pointer <Int32
audio
Get the current channel map of an audio device.
sdlGetAudioDeviceFormat (int devid , Pointer <SdlAudioSpec spec , Pointer <Int32 sampleFrames → bool
audio
Get the current audio format of a specific audio device.
sdlGetAudioDeviceGain (int devid → double
audio
Get the gain of an audio device.
sdlGetAudioDeviceName (int devid → String ?
audio
Get the human-readable name of a specific audio device.
sdlGetAudioDriver (int index → String ?
audio
Use this function to get the name of a built in audio driver.
sdlGetAudioFormatName (int format → String ?
audio
Get the human readable name of an audio format.
sdlGetAudioPlaybackDevices (Pointer <Int32 count → Pointer <Uint32
audio
Get a list of currently-connected audio playback devices.
sdlGetAudioRecordingDevices (Pointer <Int32 count → Pointer <Uint32
audio
Get a list of currently-connected audio recording devices.
sdlGetAudioStreamAvailable (Pointer <SdlAudioStream stream → int
audio
Get the number of converted/resampled bytes available.
sdlGetAudioStreamData (Pointer <SdlAudioStream stream , Pointer <NativeType buf , int len → int
audio
Get converted/resampled data from the stream.
sdlGetAudioStreamDevice (Pointer <SdlAudioStream stream → int
audio
Query an audio stream for its currently-bound device.
sdlGetAudioStreamFormat (Pointer <SdlAudioStream stream , Pointer <SdlAudioSpec srcSpec , Pointer <SdlAudioSpec dstSpec → bool
audio
Query the current format of an audio stream.
sdlGetAudioStreamFrequencyRatio (Pointer <SdlAudioStream stream → double
audio
Get the frequency ratio of an audio stream.
sdlGetAudioStreamGain (Pointer <SdlAudioStream stream → double
audio
Get the gain of an audio stream.
sdlGetAudioStreamInputChannelMap (Pointer <SdlAudioStream stream , Pointer <Int32 count → Pointer <Int32
audio
Get the current input channel map of an audio stream.
sdlGetAudioStreamOutputChannelMap (Pointer <SdlAudioStream stream , Pointer <Int32 count → Pointer <Int32
audio
Get the current output channel map of an audio stream.
sdlGetAudioStreamProperties (Pointer <SdlAudioStream stream → int
audio
Get the properties associated with an audio stream.
sdlGetAudioStreamQueued (Pointer <SdlAudioStream stream → int
audio
Get the number of bytes currently queued.
sdlGetBasePath ()
→ String ?
filesystem
Get the directory where the application was run from.
sdlGetBooleanProperty (int props , String ?name , bool defaultValue → bool
properties
Get a boolean property from a group of properties.
sdlGetCameraDriver (int index → String ?
camera
Use this function to get the name of a built in camera driver.
sdlGetCameraFormat (Pointer <SdlCamera camera , Pointer <SdlCameraSpec spec → bool
camera
Get the spec that a camera is using when generating images.
sdlGetCameraId (Pointer <SdlCamera camera → int
camera
Get the instance ID of an opened camera.
sdlGetCameraName (int instanceId → String ?
camera
Get the human-readable device name for a camera.
sdlGetCameraPermissionState (Pointer <SdlCamera camera → int
camera
Query if camera access has been approved by the user.
sdlGetCameraPosition (int instanceId → int
camera
Get the position of the camera in relation to the system.
sdlGetCameraProperties (Pointer <SdlCamera camera → int
camera
Get the properties associated with an opened camera.
sdlGetCameras (Pointer <Int32 count → Pointer <Uint32
camera
Get a list of currently connected camera devices.
sdlGetCameraSupportedFormats (int instanceId , Pointer <Int32 count → Pointer <Pointer <SdlCameraSpec
camera
Get the list of native formats/sizes a camera supports.
sdlGetClipboardData (String ?mimeType , Pointer <Uint32 size → Pointer <NativeType
clipboard
Get the data from the clipboard for a given mime type.
sdlGetClipboardMimeTypes (Pointer <Uint32 numMimeTypes → Pointer <Pointer <Int8
clipboard
Retrieve the list of mime types available in the clipboard.
sdlGetClipboardText ()
→ Pointer <Int8
clipboard
Get UTF-8 text from the clipboard.
sdlGetClosestFullscreenDisplayMode (int displayId , int w , int h , double refreshRate , bool includeHighDensityModes , Pointer <SdlDisplayMode closest → bool
video
Get the closest match to the requested display mode.
sdlGetCpuCacheLineSize ()
→ int
cpuinfo
Determine the L1 cache line size of the CPU.
sdlGetCurrentAudioDriver ()
→ String ?
audio
Get the name of the current audio driver.
sdlGetCurrentCameraDriver ()
→ String ?
camera
Get the name of the current camera driver.
sdlGetCurrentDirectory ()
→ Pointer <Int8
filesystem
Get what the system believes is the "current working directory."
sdlGetCurrentDisplayMode (int displayId → Pointer <SdlDisplayMode
video
Get information about the current display mode.
sdlGetCurrentDisplayOrientation (int displayId → int
video
Get the orientation of a display.
sdlGetCurrentRenderOutputSize (Pointer <SdlRenderer renderer , Pointer <Int32 w , Pointer <Int32 h → bool
render
Get the current output size in pixels of a rendering context.
sdlGetCurrentThreadId ()
→ int
thread
Get the thread identifier for the current thread.
sdlGetCurrentTime (Pointer <Int64 ticks → bool
time
Gets the current value of the system realtime clock in nanoseconds since
Jan 1, 1970 in Universal Coordinated Time (UTC).
sdlGetCurrentVideoDriver ()
→ String ?
video
Get the name of the currently initialized video driver.
sdlGetCursor ()
→ Pointer <SdlCursor
mouse
Get the active cursor.
sdlGetDateTimeLocalePreferences (Pointer <Int32 dateFormat , Pointer <Int32 timeFormat → bool
time
Gets the current preferred date and time format for the system locale.
sdlGetDayOfWeek (int year , int month , int day → int
time
Get the day of week for a calendar date.
sdlGetDayOfYear (int year , int month , int day → int
time
Get the day of year for a calendar date.
sdlGetDaysInMonth (int year , int month → int
time
Get the number of days in a month for a given year.
sdlGetDefaultAssertionHandler ()
→ Pointer <NativeFunction <SdlAssertionHandler
assert
Get the default assertion handler.
sdlGetDefaultCursor ()
→ Pointer <SdlCursor
mouse
Get the default cursor.
sdlGetDefaultLogOutputFunction ()
→ Pointer <NativeFunction <SdlLogOutputFunction
log
Get the default log output function.
sdlGetDefaultTextureScaleMode (Pointer <SdlRenderer renderer , Pointer <Int32 scaleMode → bool
render
Get default texture scale mode of the given renderer.
sdlGetDesktopDisplayMode (int displayId → Pointer <SdlDisplayMode
video
Get information about the desktop's display mode.
sdlGetDirect3D9AdapterIndex (int displayId → int
system
Get the D3D9 adapter index that matches the specified display.
sdlGetDisplayBounds (int displayId , Pointer <SdlRect rect → bool
video
Get the desktop area represented by a display.
sdlGetDisplayContentScale (int displayId → double
video
Get the content scale of a display.
sdlGetDisplayForPoint (Pointer <SdlPoint point → int
video
Get the display containing a point.
sdlGetDisplayForRect (Pointer <SdlRect rect → int
video
Get the display primarily containing a rect.
sdlGetDisplayForWindow (Pointer <SdlWindow window → int
video
Get the display associated with a window.
sdlGetDisplayName (int displayId → String ?
video
Get the name of a display in UTF-8 encoding.
sdlGetDisplayProperties (int displayId → int
video
Get the properties associated with a display.
sdlGetDisplays (Pointer <Int32 count → Pointer <Uint32
video
Get a list of currently connected displays.
sdlGetDisplayUsableBounds (int displayId , Pointer <SdlRect rect → bool
video
Get the usable desktop area represented by a display, in screen
coordinates.
sdlGetDxgiOutputInfo (int displayId , Pointer <Int32 adapterIndex , Pointer <Int32 outputIndex → bool
system
Get the DXGI Adapter and Output indices for the specified display.
sdlGetenv (String ?name → String ?
stdinc
Get the value of a variable in the environment.
sdlGetEnvironment ()
→ Pointer <SdlEnvironment
stdinc
Get the process environment.
sdlGetEnvironmentVariable (Pointer <SdlEnvironment env , String ?name → String ?
stdinc
Get the value of a variable in the environment.
sdlGetEnvironmentVariables (Pointer <SdlEnvironment env → Pointer <Pointer <Int8
stdinc
Get all variables in the environment.
sdlGetenvUnsafe (String ?name → String ?
stdinc
Get the value of a variable in the environment.
sdlGetError ()
→ String ?
error
Retrieve a message about the last error that occurred on the current
thread.
sdlGetEventDescription (Pointer <SdlEvent event , Pointer <Int8 buf , int buflen → int
events
Generate a human-readable description of an event.
sdlGetEventFilter (Pointer <Pointer <NativeFunction <SdlEventFilter filter , Pointer <Pointer <NativeType userdata → bool
events
Query the current event filter.
sdlGetFloatProperty (int props , String ?name , double defaultValue → double
properties
Get a floating point property from a group of properties.
sdlGetFullscreenDisplayModes (int displayId , Pointer <Int32 count → Pointer <Pointer <SdlDisplayMode
video
Get a list of fullscreen display modes available on a display.
sdlGetGamepadAppleSfSymbolsNameForAxis (Pointer <SdlGamepad gamepad , int axis → String ?
gamepad
Return the sfSymbolsName for a given axis on a gamepad on Apple platforms.
sdlGetGamepadAppleSfSymbolsNameForButton (Pointer <SdlGamepad gamepad , int button → String ?
gamepad
Return the sfSymbolsName for a given button on a gamepad on Apple
platforms.
sdlGetGamepadAxis (Pointer <SdlGamepad gamepad , int axis → int
gamepad
Get the current state of an axis control on a gamepad.
sdlGetGamepadAxisFromString (String ?str → int
gamepad
Convert a string into SDL_GamepadAxis enum.
sdlGetGamepadBindings (Pointer <SdlGamepad gamepad , Pointer <Int32 count → Pointer <Pointer <SdlGamepadBinding
gamepad
Get the SDL joystick layer bindings for a gamepad.
sdlGetGamepadButton (Pointer <SdlGamepad gamepad , int button → bool
gamepad
Get the current state of a button on a gamepad.
sdlGetGamepadButtonFromString (String ?str → int
gamepad
Convert a string into an SDL_GamepadButton enum.
sdlGetGamepadButtonLabel (Pointer <SdlGamepad gamepad , int button → int
gamepad
Get the label of a button on a gamepad.
sdlGetGamepadButtonLabelForType (int type , int button → int
gamepad
Get the label of a button on a gamepad.
sdlGetGamepadConnectionState (Pointer <SdlGamepad gamepad → int
gamepad
Get the connection state of a gamepad.
sdlGetGamepadFirmwareVersion (Pointer <SdlGamepad gamepad → int
gamepad
Get the firmware version of an opened gamepad, if available.
sdlGetGamepadFromId (int instanceId → Pointer <SdlGamepad
gamepad
Get the SDL_Gamepad associated with a joystick instance ID, if it has been
opened.
sdlGetGamepadFromPlayerIndex (int playerIndex → Pointer <SdlGamepad
gamepad
Get the SDL_Gamepad associated with a player index.
sdlGetGamepadGuidForId (int instanceId → SdlGuid
gamepad
Get the implementation-dependent GUID of a gamepad.
sdlGetGamepadId (Pointer <SdlGamepad gamepad → int
gamepad
Get the instance ID of an opened gamepad.
sdlGetGamepadJoystick (Pointer <SdlGamepad gamepad → Pointer <SdlJoystick
gamepad
Get the underlying joystick from a gamepad.
sdlGetGamepadMapping (Pointer <SdlGamepad gamepad → Pointer <Int8
gamepad
Get the current mapping of a gamepad.
sdlGetGamepadMappingForGuid (SdlGuid guid → Pointer <Int8
gamepad
Get the gamepad mapping string for a given GUID.
sdlGetGamepadMappingForId (int instanceId → Pointer <Int8
gamepad
Get the mapping of a gamepad.
sdlGetGamepadMappings (Pointer <Int32 count → Pointer <Pointer <Int8
gamepad
Get the current gamepad mappings.
sdlGetGamepadName (Pointer <SdlGamepad gamepad → String ?
gamepad
Get the implementation-dependent name for an opened gamepad.
sdlGetGamepadNameForId (int instanceId → String ?
gamepad
Get the implementation dependent name of a gamepad.
sdlGetGamepadPath (Pointer <SdlGamepad gamepad → String ?
gamepad
Get the implementation-dependent path for an opened gamepad.
sdlGetGamepadPathForId (int instanceId → String ?
gamepad
Get the implementation dependent path of a gamepad.
sdlGetGamepadPlayerIndex (Pointer <SdlGamepad gamepad → int
gamepad
Get the player index of an opened gamepad.
sdlGetGamepadPlayerIndexForId (int instanceId → int
gamepad
Get the player index of a gamepad.
sdlGetGamepadPowerInfo (Pointer <SdlGamepad gamepad , Pointer <Int32 percent → int
gamepad
Get the battery state of a gamepad.
sdlGetGamepadProduct (Pointer <SdlGamepad gamepad → int
gamepad
Get the USB product ID of an opened gamepad, if available.
sdlGetGamepadProductForId (int instanceId → int
gamepad
Get the USB product ID of a gamepad, if available.
sdlGetGamepadProductVersion (Pointer <SdlGamepad gamepad → int
gamepad
Get the product version of an opened gamepad, if available.
sdlGetGamepadProductVersionForId (int instanceId → int
gamepad
Get the product version of a gamepad, if available.
sdlGetGamepadProperties (Pointer <SdlGamepad gamepad → int
gamepad
Get the properties associated with an opened gamepad.
sdlGetGamepads (Pointer <Int32 count → Pointer <Uint32
gamepad
Get a list of currently connected gamepads.
sdlGetGamepadSensorData (Pointer <SdlGamepad gamepad , int type , Pointer <Float data , int numValues → bool
gamepad
Get the current state of a gamepad sensor.
sdlGetGamepadSensorDataRate (Pointer <SdlGamepad gamepad , int type → double
gamepad
Get the data rate (number of events per second) of a gamepad sensor.
sdlGetGamepadSerial (Pointer <SdlGamepad gamepad → String ?
gamepad
Get the serial number of an opened gamepad, if available.
sdlGetGamepadSteamHandle (Pointer <SdlGamepad gamepad → int
gamepad
Get the Steam Input handle of an opened gamepad, if available.
sdlGetGamepadStringForAxis (int axis → String ?
gamepad
Convert from an SDL_GamepadAxis enum to a string.
sdlGetGamepadStringForButton (int button → String ?
gamepad
Convert from an SDL_GamepadButton enum to a string.
sdlGetGamepadStringForType (int type → String ?
gamepad
Convert from an SDL_GamepadType enum to a string.
sdlGetGamepadTouchpadFinger (Pointer <SdlGamepad gamepad , int touchpad , int finger , Pointer <Uint8 down , Pointer <Float x , Pointer <Float y , Pointer <Float pressure → bool
gamepad
Get the current state of a finger on a touchpad on a gamepad.
sdlGetGamepadType (Pointer <SdlGamepad gamepad → int
gamepad
Get the type of an opened gamepad.
sdlGetGamepadTypeForId (int instanceId → int
gamepad
Get the type of a gamepad.
sdlGetGamepadTypeFromString (String ?str → int
gamepad
Convert a string into SDL_GamepadType enum.
sdlGetGamepadVendor (Pointer <SdlGamepad gamepad → int
gamepad
Get the USB vendor ID of an opened gamepad, if available.
sdlGetGamepadVendorForId (int instanceId → int
gamepad
Get the USB vendor ID of a gamepad, if available.
sdlGetGdkDefaultUser (Pointer <XUserHandle outUserHandle → bool
system
Gets a reference to the default user handle for GDK.
sdlGetGdkTaskQueue (Pointer <XTaskQueueHandle outTaskQueue → bool
system
Gets a reference to the global async task queue handle for GDK,
initializing if needed.
sdlGetGlobalMouseState (Pointer <Float x , Pointer <Float y → int
mouse
Query the platform for the asynchronous mouse button state and the
desktop-relative platform-cursor position.
sdlGetGlobalProperties ()
→ int
properties
Get the global SDL properties.
sdlGetGpuDeviceDriver (Pointer <SdlGpuDevice device → String ?
gpu
Returns the name of the backend used to create this GPU context.
sdlGetGpuDeviceProperties (Pointer <SdlGpuDevice device → int
gpu
Get the properties associated with a GPU device.
sdlGetGpuDriver (int index → String ?
gpu
Get the name of a built in GPU driver.
sdlGetGpuShaderFormats (Pointer <SdlGpuDevice device → int
gpu
Returns the supported shader formats for this GPU context.
sdlGetGpuSwapchainTextureFormat (Pointer <SdlGpuDevice device , Pointer <SdlWindow window → int
gpu
Obtains the texture format of the swapchain for the given window.
sdlGetGpuTextureFormatFromPixelFormat (int format → int
gpu
Get the GPU texture format corresponding to an SDL pixel format.
sdlGetGrabbedWindow ()
→ Pointer <SdlWindow
video
Get the window that currently has an input grab enabled.
sdlGetHapticEffectStatus (Pointer <SdlHaptic haptic , int effect → bool
haptic
Get the status of the current effect on the specified haptic device.
sdlGetHapticFeatures (Pointer <SdlHaptic haptic → int
haptic
Get the haptic device's supported features in bitwise manner.
sdlGetHapticFromId (int instanceId → Pointer <SdlHaptic
haptic
Get the SDL_Haptic associated with an instance ID, if it has been opened.
sdlGetHapticId (Pointer <SdlHaptic haptic → int
haptic
Get the instance ID of an opened haptic device.
sdlGetHapticName (Pointer <SdlHaptic haptic → String ?
haptic
Get the implementation dependent name of a haptic device.
sdlGetHapticNameForId (int instanceId → String ?
haptic
Get the implementation dependent name of a haptic device.
sdlGetHaptics (Pointer <Int32 count → Pointer <Uint32
haptic
Get a list of currently connected haptic devices.
sdlGetHint (String ?name → String ?
hints
Get the value of a hint.
sdlGetHintBoolean (String ?name , bool defaultValue → bool
hints
Get the boolean value of a hint variable.
sdlGetIoProperties (Pointer <SdlIoStream context → int
iostream
Get the properties associated with an SDL_IOStream.
sdlGetIoSize (Pointer <SdlIoStream context → int
iostream
Use this function to get the size of the data stream in an SDL_IOStream.
sdlGetIoStatus (Pointer <SdlIoStream context → int
iostream
Query the stream status of an SDL_IOStream.
sdlGetJoystickAxis (Pointer <SdlJoystick joystick , int axis → int
joystick
Get the current state of an axis control on a joystick.
sdlGetJoystickAxisInitialState (Pointer <SdlJoystick joystick , int axis , Pointer <Int16 state → bool
joystick
Get the initial state of an axis control on a joystick.
sdlGetJoystickBall (Pointer <SdlJoystick joystick , int ball , Pointer <Int32 dx , Pointer <Int32 dy → bool
joystick
Get the ball axis change since the last poll.
sdlGetJoystickButton (Pointer <SdlJoystick joystick , int button → bool
joystick
Get the current state of a button on a joystick.
sdlGetJoystickConnectionState (Pointer <SdlJoystick joystick → int
joystick
Get the connection state of a joystick.
sdlGetJoystickFirmwareVersion (Pointer <SdlJoystick joystick → int
joystick
Get the firmware version of an opened joystick, if available.
sdlGetJoystickFromId (int instanceId → Pointer <SdlJoystick
joystick
Get the SDL_Joystick associated with an instance ID, if it has been opened.
sdlGetJoystickFromPlayerIndex (int playerIndex → Pointer <SdlJoystick
joystick
Get the SDL_Joystick associated with a player index.
sdlGetJoystickGuid (Pointer <SdlJoystick joystick → SdlGuid
joystick
Get the implementation-dependent GUID for the joystick.
sdlGetJoystickGuidForId (int instanceId → SdlGuid
joystick
Get the implementation-dependent GUID of a joystick.
sdlGetJoystickGuidInfo (SdlGuid guid , Pointer <Uint16 vendor , Pointer <Uint16 product , Pointer <Uint16 version , Pointer <Uint16 crc16 → void
joystick
Get the device information encoded in a SDL_GUID structure.
sdlGetJoystickHat (Pointer <SdlJoystick joystick , int hat → int
joystick
Get the current state of a POV hat on a joystick.
sdlGetJoystickId (Pointer <SdlJoystick joystick → int
joystick
Get the instance ID of an opened joystick.
sdlGetJoystickName (Pointer <SdlJoystick joystick → String ?
joystick
Get the implementation dependent name of a joystick.
sdlGetJoystickNameForId (int instanceId → String ?
joystick
Get the implementation dependent name of a joystick.
sdlGetJoystickPath (Pointer <SdlJoystick joystick → String ?
joystick
Get the implementation dependent path of a joystick.
sdlGetJoystickPathForId (int instanceId → String ?
joystick
Get the implementation dependent path of a joystick.
sdlGetJoystickPlayerIndex (Pointer <SdlJoystick joystick → int
joystick
Get the player index of an opened joystick.
sdlGetJoystickPlayerIndexForId (int instanceId → int
joystick
Get the player index of a joystick.
sdlGetJoystickPowerInfo (Pointer <SdlJoystick joystick , Pointer <Int32 percent → int
joystick
Get the battery state of a joystick.
sdlGetJoystickProduct (Pointer <SdlJoystick joystick → int
joystick
Get the USB product ID of an opened joystick, if available.
sdlGetJoystickProductForId (int instanceId → int
joystick
Get the USB product ID of a joystick, if available.
sdlGetJoystickProductVersion (Pointer <SdlJoystick joystick → int
joystick
Get the product version of an opened joystick, if available.
sdlGetJoystickProductVersionForId (int instanceId → int
joystick
Get the product version of a joystick, if available.
sdlGetJoystickProperties (Pointer <SdlJoystick joystick → int
joystick
Get the properties associated with a joystick.
sdlGetJoysticks (Pointer <Int32 count → Pointer <Uint32
joystick
Get a list of currently connected joysticks.
sdlGetJoystickSerial (Pointer <SdlJoystick joystick → String ?
joystick
Get the serial number of an opened joystick, if available.
sdlGetJoystickType (Pointer <SdlJoystick joystick → int
joystick
Get the type of an opened joystick.
sdlGetJoystickTypeForId (int instanceId → int
joystick
Get the type of a joystick, if available.
sdlGetJoystickVendor (Pointer <SdlJoystick joystick → int
joystick
Get the USB vendor ID of an opened joystick, if available.
sdlGetJoystickVendorForId (int instanceId → int
joystick
Get the USB vendor ID of a joystick, if available.
sdlGetKeyboardFocus ()
→ Pointer <SdlWindow
keyboard
Query the window which currently has keyboard focus.
sdlGetKeyboardNameForId (int instanceId → String ?
keyboard
Get the name of a keyboard.
sdlGetKeyboards (Pointer <Int32 count → Pointer <Uint32
keyboard
Get a list of currently connected keyboards.
sdlGetKeyboardState (Pointer <Int32 numkeys → Pointer <Uint8
keyboard
Get a snapshot of the current state of the keyboard.
sdlGetKeyFromName (String ?name → int
keyboard
Get a key code from a human-readable name.
sdlGetKeyFromScancode (int scancode , int modstate , bool keyEvent → int
keyboard
Get the key code corresponding to the given scancode according to the
current keyboard layout.
sdlGetKeyName (int key → String ?
keyboard
Get a human-readable name for a key.
sdlGetLogOutputFunction (Pointer <Pointer <NativeFunction <SdlLogOutputFunction callback , Pointer <Pointer <NativeType userdata → void
log
Get the current log output function.
sdlGetLogPriority (int category → int
log
Get the priority of a particular log category.
sdlGetMasksForPixelFormat (int format , Pointer <Int32 bpp , Pointer <Uint32 rmask , Pointer <Uint32 gmask , Pointer <Uint32 bmask , Pointer <Uint32 amask → bool
pixels
Convert one of the enumerated pixel formats to a bpp value and RGBA masks.
sdlGetMaxHapticEffects (Pointer <SdlHaptic haptic → int
haptic
Get the number of effects a haptic device can store.
sdlGetMaxHapticEffectsPlaying (Pointer <SdlHaptic haptic → int
haptic
Get the number of effects a haptic device can play at the same time.
sdlGetMemoryFunctions (Pointer <Pointer <NativeFunction <SdlMallocFunc mallocFunc , Pointer <Pointer <NativeFunction <SdlCallocFunc callocFunc , Pointer <Pointer <NativeFunction <SdlReallocFunc reallocFunc , Pointer <Pointer <NativeFunction <SdlFreeFunc freeFunc → void
stdinc
Get the current set of SDL memory functions.
sdlGetMice (Pointer <Int32 count → Pointer <Uint32
mouse
Get a list of currently connected mice.
sdlGetModState ()
→ int
keyboard
Get the current key modifier state for the keyboard.
sdlGetMouseFocus ()
→ Pointer <SdlWindow
mouse
Get the window which currently has mouse focus.
sdlGetMouseNameForId (int instanceId → String ?
mouse
Get the name of a mouse.
sdlGetMouseState (Pointer <Float x , Pointer <Float y → int
mouse
Query SDL's cache for the synchronous mouse button state and the
window-relative SDL-cursor position.
sdlGetNaturalDisplayOrientation (int displayId → int
video
Get the orientation of a display when it is unrotated.
sdlGetNumAllocations ()
→ int
stdinc
Get the number of outstanding (unfreed) allocations.
sdlGetNumAudioDrivers ()
→ int
audio
Use this function to get the number of built-in audio drivers.
sdlGetNumberProperty (int props , String ?name , int defaultValue → int
properties
Get a number property from a group of properties.
sdlGetNumCameraDrivers ()
→ int
camera
Use this function to get the number of built-in camera drivers.
sdlGetNumGamepadTouchpadFingers (Pointer <SdlGamepad gamepad , int touchpad → int
gamepad
Get the number of supported simultaneous fingers on a touchpad on a game
gamepad.
sdlGetNumGamepadTouchpads (Pointer <SdlGamepad gamepad → int
gamepad
Get the number of touchpads on a gamepad.
sdlGetNumGpuDrivers ()
→ int
gpu
Get the number of GPU drivers compiled into SDL.
sdlGetNumHapticAxes (Pointer <SdlHaptic haptic → int
haptic
Get the number of haptic axes the device has.
sdlGetNumJoystickAxes (Pointer <SdlJoystick joystick → int
joystick
Get the number of general axis controls on a joystick.
sdlGetNumJoystickBalls (Pointer <SdlJoystick joystick → int
joystick
Get the number of trackballs on a joystick.
sdlGetNumJoystickButtons (Pointer <SdlJoystick joystick → int
joystick
Get the number of buttons on a joystick.
sdlGetNumJoystickHats (Pointer <SdlJoystick joystick → int
joystick
Get the number of POV hats on a joystick.
sdlGetNumLogicalCpuCores ()
→ int
cpuinfo
Get the number of logical CPU cores available.
sdlGetNumRenderDrivers ()
→ int
render
Get the number of 2D rendering drivers available for the current display.
sdlGetNumVideoDrivers ()
→ int
video
Get the number of video drivers compiled into SDL.
sdlGetOriginalMemoryFunctions (Pointer <Pointer <NativeFunction <SdlMallocFunc mallocFunc , Pointer <Pointer <NativeFunction <SdlCallocFunc callocFunc , Pointer <Pointer <NativeFunction <SdlReallocFunc reallocFunc , Pointer <Pointer <NativeFunction <SdlFreeFunc freeFunc → void
stdinc
Get the original set of SDL memory functions.
sdlGetPathInfo (String ?path , Pointer <SdlPathInfo info → bool
filesystem
Get information about a filesystem path.
sdlGetPerformanceCounter ()
→ int
timer
Get the current value of the high resolution counter.
sdlGetPerformanceFrequency ()
→ int
timer
Get the count per second of the high resolution counter.
sdlGetPixelFormatDetails (int format → Pointer <SdlPixelFormatDetails
pixels
Create an SDL_PixelFormatDetails structure corresponding to a pixel format.
sdlGetPixelFormatForMasks (int bpp , int rmask , int gmask , int bmask , int amask → int
pixels
Convert a bpp value and RGBA masks to an enumerated pixel format.
sdlGetPixelFormatFromGpuTextureFormat (int format → int
gpu
Get the SDL pixel format corresponding to a GPU texture format.
sdlGetPixelFormatName (int format → String ?
pixels
Get the human readable name of a pixel format.
sdlGetPlatform ()
→ String ?
platform
Get the name of the platform.
sdlGetPointerProperty (int props , String ?name , Pointer <NativeType defaultValue → Pointer <NativeType
properties
Get a pointer property from a group of properties.
sdlGetPowerInfo (Pointer <Int32 seconds , Pointer <Int32 percent → int
power
Get the current power supply details.
sdlGetPreferredLocales (Pointer <Int32 count → Pointer <Pointer <SdlLocale
locale
Report the user's preferred locale.
sdlGetPrefPath (String ?org , String ?app → Pointer <Int8
filesystem
Get the user-and-app-specific path where files can be written.
sdlGetPrimaryDisplay ()
→ int
video
Return the primary display.
sdlGetPrimarySelectionText ()
→ Pointer <Int8
clipboard
Get UTF-8 text from the primary selection.
sdlGetProcessInput (Pointer <SdlProcess process → Pointer <SdlIoStream
process
Get the SDL_IOStream associated with process standard input.
sdlGetProcessOutput (Pointer <SdlProcess process → Pointer <SdlIoStream
process
Get the SDL_IOStream associated with process standard output.
sdlGetProcessProperties (Pointer <SdlProcess process → int
process
Get the properties associated with a process.
sdlGetPropertyType (int props , String ?name → int
properties
Get the type of a property in a group of properties.
sdlGetRealGamepadType (Pointer <SdlGamepad gamepad → int
gamepad
Get the type of an opened gamepad, ignoring any mapping override.
sdlGetRealGamepadTypeForId (int instanceId → int
gamepad
Get the type of a gamepad, ignoring any mapping override.
sdlGetRectAndLineIntersection (Pointer <SdlRect rect , Pointer <Int32 x1 , Pointer <Int32 y1 , Pointer <Int32 x2 , Pointer <Int32 y2 → bool
rect
Calculate the intersection of a rectangle and line segment.
sdlGetRectAndLineIntersectionFloat (Pointer <SdlFRect rect , Pointer <Float x1 , Pointer <Float y1 , Pointer <Float x2 , Pointer <Float y2 → bool
rect
Calculate the intersection of a rectangle and line segment with float
precision.
sdlGetRectEnclosingPoints (Pointer <SdlPoint points , int count , Pointer <SdlRect clip , Pointer <SdlRect result → bool
rect
Calculate a minimal rectangle enclosing a set of points.
sdlGetRectEnclosingPointsFloat (Pointer <SdlFPoint points , int count , Pointer <SdlFRect clip , Pointer <SdlFRect result → bool
rect
Calculate a minimal rectangle enclosing a set of points with float
precision.
sdlGetRectIntersection (Pointer <SdlRect a , Pointer <SdlRect b , Pointer <SdlRect result → bool
rect
Calculate the intersection of two rectangles.
sdlGetRectIntersectionFloat (Pointer <SdlFRect a , Pointer <SdlFRect b , Pointer <SdlFRect result → bool
rect
Calculate the intersection of two rectangles with float precision.
sdlGetRectUnion (Pointer <SdlRect a , Pointer <SdlRect b , Pointer <SdlRect result → bool
rect
Calculate the union of two rectangles.
sdlGetRectUnionFloat (Pointer <SdlFRect a , Pointer <SdlFRect b , Pointer <SdlFRect result → bool
rect
Calculate the union of two rectangles with float precision.
sdlGetRelativeMouseState (Pointer <Float x , Pointer <Float y → int
mouse
Query SDL's cache for the synchronous mouse button state and accumulated
mouse delta since last call.
sdlGetRenderClipRect (Pointer <SdlRenderer renderer , Pointer <SdlRect rect → bool
render
Get the clip rectangle for the current target.
sdlGetRenderColorScale (Pointer <SdlRenderer renderer , Pointer <Float scale → bool
render
Get the color scale used for render operations.
sdlGetRenderDrawBlendMode (Pointer <SdlRenderer renderer , Pointer <Uint32 blendMode → bool
render
Get the blend mode used for drawing operations.
sdlGetRenderDrawColor (Pointer <SdlRenderer renderer , Pointer <Uint8 r , Pointer <Uint8 g , Pointer <Uint8 b , Pointer <Uint8 a → bool
render
Get the color used for drawing operations (Rect, Line and Clear).
sdlGetRenderDrawColorFloat (Pointer <SdlRenderer renderer , Pointer <Float r , Pointer <Float g , Pointer <Float b , Pointer <Float a → bool
render
Get the color used for drawing operations (Rect, Line and Clear).
sdlGetRenderDriver (int index → String ?
render
Use this function to get the name of a built in 2D rendering driver.
sdlGetRenderer (Pointer <SdlWindow window → Pointer <SdlRenderer
render
Get the renderer associated with a window.
sdlGetRendererFromTexture (Pointer <SdlTexture texture → Pointer <SdlRenderer
render
Get the renderer that created an SDL_Texture.
sdlGetRendererName (Pointer <SdlRenderer renderer → String ?
render
Get the name of a renderer.
sdlGetRendererProperties (Pointer <SdlRenderer renderer → int
render
Get the properties associated with a renderer.
sdlGetRenderLogicalPresentation (Pointer <SdlRenderer renderer , Pointer <Int32 w , Pointer <Int32 h , Pointer <Int32 mode → bool
render
Get device independent resolution and presentation mode for rendering.
sdlGetRenderLogicalPresentationRect (Pointer <SdlRenderer renderer , Pointer <SdlFRect rect → bool
render
Get the final presentation rectangle for rendering.
sdlGetRenderMetalCommandEncoder (Pointer <SdlRenderer renderer → Pointer <NativeType
render
Get the Metal command encoder for the current frame.
sdlGetRenderMetalLayer (Pointer <SdlRenderer renderer → Pointer <NativeType
render
Get the CAMetalLayer associated with the given Metal renderer.
sdlGetRenderOutputSize (Pointer <SdlRenderer renderer , Pointer <Int32 w , Pointer <Int32 h → bool
render
Get the output size in pixels of a rendering context.
sdlGetRenderSafeArea (Pointer <SdlRenderer renderer , Pointer <SdlRect rect → bool
render
Get the safe area for rendering within the current viewport.
sdlGetRenderScale (Pointer <SdlRenderer renderer , Pointer <Float scaleX , Pointer <Float scaleY → bool
render
Get the drawing scale for the current target.
sdlGetRenderTarget (Pointer <SdlRenderer renderer → Pointer <SdlTexture
render
Get the current render target.
sdlGetRenderTextureAddressMode (Pointer <SdlRenderer renderer , Pointer <Int32 uMode , Pointer <Int32 vMode → bool
render
Get the texture addressing mode used in SDL_RenderGeometry().
sdlGetRenderViewport (Pointer <SdlRenderer renderer , Pointer <SdlRect rect → bool
render
Get the drawing area for the current target.
sdlGetRenderVSync (Pointer <SdlRenderer renderer , Pointer <Int32 vsync → bool
render
Get VSync of the given renderer.
sdlGetRenderWindow (Pointer <SdlRenderer renderer → Pointer <SdlWindow
render
Get the window associated with a renderer.
sdlGetRevision ()
→ String ?
version
Get the code revision of the SDL library that is linked against your
program.
sdlGetRgb (int pixelvalue , Pointer <SdlPixelFormatDetails format , Pointer <SdlPalette palette , Pointer <Uint8 r , Pointer <Uint8 g , Pointer <Uint8 b → void
pixels
Get RGB values from a pixel in the specified format.
sdlGetRgba (int pixelvalue , Pointer <SdlPixelFormatDetails format , Pointer <SdlPalette palette , Pointer <Uint8 r , Pointer <Uint8 g , Pointer <Uint8 b , Pointer <Uint8 a → void
pixels
Get RGBA values from a pixel in the specified format.
sdlGetSandbox ()
→ int
system
Get the application sandbox environment, if any.
sdlGetScancodeFromKey (int key , Pointer <Uint16 modstate → int
keyboard
Get the scancode corresponding to the given key code according to the
current keyboard layout.
sdlGetScancodeFromName (String ?name → int
keyboard
Get a scancode from a human-readable name.
sdlGetScancodeName (int scancode → String ?
keyboard
Get a human-readable name for a scancode.
sdlGetSemaphoreValue (Pointer <SdlSemaphore sem → int
mutex
Get the current value of a semaphore.
sdlGetSensorData (Pointer <SdlSensor sensor , Pointer <Float data , int numValues → bool
sensor
Get the current state of an opened sensor.
sdlGetSensorFromId (int instanceId → Pointer <SdlSensor
sensor
Return the SDL_Sensor associated with an instance ID.
sdlGetSensorId (Pointer <SdlSensor sensor → int
sensor
Get the instance ID of a sensor.
sdlGetSensorName (Pointer <SdlSensor sensor → String ?
sensor
Get the implementation dependent name of a sensor.
sdlGetSensorNameForId (int instanceId → String ?
sensor
Get the implementation dependent name of a sensor.
sdlGetSensorNonPortableType (Pointer <SdlSensor sensor → int
sensor
Get the platform dependent type of a sensor.
sdlGetSensorNonPortableTypeForId (int instanceId → int
sensor
Get the platform dependent type of a sensor.
sdlGetSensorProperties (Pointer <SdlSensor sensor → int
sensor
Get the properties associated with a sensor.
sdlGetSensors (Pointer <Int32 count → Pointer <Uint32
sensor
Get a list of currently connected sensors.
sdlGetSensorType (Pointer <SdlSensor sensor → int
sensor
Get the type of a sensor.
sdlGetSensorTypeForId (int instanceId → int
sensor
Get the type of a sensor.
sdlGetSilenceValueForFormat (int format → int
audio
Get the appropriate memset value for silencing an audio format.
sdlGetSimdAlignment ()
→ int
cpuinfo
Report the alignment this system needs for SIMD allocations.
sdlGetStorageFileSize (Pointer <SdlStorage storage , String ?path , Pointer <Uint64 length → bool
storage
Query the size of a file within a storage container.
sdlGetStoragePathInfo (Pointer <SdlStorage storage , String ?path , Pointer <SdlPathInfo info → bool
storage
Get information about a filesystem path in a storage container.
sdlGetStorageSpaceRemaining (Pointer <SdlStorage storage → int
storage
Queries the remaining space in a storage container.
sdlGetStringProperty (int props , String ?name , String ?defaultValue → String ?
properties
Get a string property from a group of properties.
sdlGetSurfaceAlphaMod (Pointer <SdlSurface surface , Pointer <Uint8 alpha → bool
surface
Get the additional alpha value used in blit operations.
sdlGetSurfaceBlendMode (Pointer <SdlSurface surface , Pointer <Uint32 blendMode → bool
surface
Get the blend mode used for blit operations.
sdlGetSurfaceClipRect (Pointer <SdlSurface surface , Pointer <SdlRect rect → bool
surface
Get the clipping rectangle for a surface.
sdlGetSurfaceColorKey (Pointer <SdlSurface surface , Pointer <Uint32 key → bool
surface
Get the color key (transparent pixel) for a surface.
sdlGetSurfaceColorMod (Pointer <SdlSurface surface , Pointer <Uint8 r , Pointer <Uint8 g , Pointer <Uint8 b → bool
surface
Get the additional color value multiplied into blit operations.
sdlGetSurfaceColorspace (Pointer <SdlSurface surface → int
surface
Get the colorspace used by a surface.
sdlGetSurfaceImages (Pointer <SdlSurface surface , Pointer <Int32 count → Pointer <Pointer <SdlSurface
surface
Get an array including all versions of a surface.
sdlGetSurfacePalette (Pointer <SdlSurface surface → Pointer <SdlPalette
surface
Get the palette used by a surface.
sdlGetSurfaceProperties (Pointer <SdlSurface surface → int
surface
Get the properties associated with a surface.
sdlGetSystemRam ()
→ int
cpuinfo
Get the amount of RAM configured in the system.
sdlGetSystemTheme ()
→ int
video
Get the current system theme.
sdlGetTextInputArea (Pointer <SdlWindow window , Pointer <SdlRect rect , Pointer <Int32 cursor → bool
keyboard
Get the area used to type Unicode text input.
sdlGetTextureAlphaMod (Pointer <SdlTexture texture , Pointer <Uint8 alpha → bool
render
Get the additional alpha value multiplied into render copy operations.
sdlGetTextureAlphaModFloat (Pointer <SdlTexture texture , Pointer <Float alpha → bool
render
Get the additional alpha value multiplied into render copy operations.
sdlGetTextureBlendMode (Pointer <SdlTexture texture , Pointer <Uint32 blendMode → bool
render
Get the blend mode used for texture copy operations.
sdlGetTextureColorMod (Pointer <SdlTexture texture , Pointer <Uint8 r , Pointer <Uint8 g , Pointer <Uint8 b → bool
render
Get the additional color value multiplied into render copy operations.
sdlGetTextureColorModFloat (Pointer <SdlTexture texture , Pointer <Float r , Pointer <Float g , Pointer <Float b → bool
render
Get the additional color value multiplied into render copy operations.
sdlGetTextureProperties (Pointer <SdlTexture texture → int
render
Get the properties associated with a texture.
sdlGetTextureScaleMode (Pointer <SdlTexture texture , Pointer <Int32 scaleMode → bool
render
Get the scale mode used for texture scale operations.
sdlGetTextureSize (Pointer <SdlTexture texture , Pointer <Float w , Pointer <Float h → bool
render
Get the size of a texture, as floating point values.
sdlGetThreadId (Pointer <SdlThread thread → int
thread
Get the thread identifier for the specified thread.
sdlGetThreadName (Pointer <SdlThread thread → String ?
thread
Get the thread name as it was specified in SDL_CreateThread().
sdlGetThreadState (Pointer <SdlThread thread → int
thread
Get the current state of a thread.
sdlGetTicks ()
→ int
timer
Get the number of milliseconds that have elapsed since the SDL library
initialization.
sdlGetTicksNs ()
→ int
timer
Get the number of nanoseconds since SDL library initialization.
sdlGetTls (Pointer <SdlAtomicInt id → Pointer <NativeType
thread
Get the current thread's value associated with a thread local storage ID.
sdlGetTouchDeviceName (int touchId → String ?
touch
Get the touch device name as reported from the driver.
sdlGetTouchDevices (Pointer <Int32 count → Pointer <Uint64
touch
Get a list of registered touch devices.
sdlGetTouchDeviceType (int touchId → int
touch
Get the type of the given touch device.
sdlGetTouchFingers (int touchId , Pointer <Int32 count → Pointer <Pointer <SdlFinger
touch
Get a list of active fingers for a given touch device.
sdlGetTrayEntries (Pointer <Int32 count → Pointer <Pointer <SdlTrayEntry
tray
Returns a list of entries in the menu, in order.
sdlGetTrayEntryChecked (Pointer <SdlTrayEntry entry → bool
tray
Gets whether or not an entry is checked.
sdlGetTrayEntryEnabled (Pointer <SdlTrayEntry entry → bool
tray
Gets whether or not an entry is enabled.
sdlGetTrayEntryLabel (Pointer <SdlTrayEntry entry → String ?
tray
Gets the label of an entry.
sdlGetTrayEntryParent (Pointer <SdlTrayEntry entry → Pointer <SdlTrayMenu
tray
Gets the menu containing a certain tray entry.
Gets a previously created tray menu.
Gets the entry for which the menu is a submenu, if the current menu is a
submenu.
Gets the tray for which this menu is the first-level menu, if the current
menu isn't a submenu.
Gets a previously created tray entry submenu.
sdlGetUserFolder (int folder → String ?
filesystem
Finds the most suitable user folder for a specific purpose.
sdlGetVersion ()
→ int
version
Get the version of SDL that is linked against your program.
sdlGetVideoDriver (int index → String ?
video
Get the name of a built in video driver.
sdlGetWindowAspectRatio (Pointer <SdlWindow window , Pointer <Float minAspect , Pointer <Float maxAspect → bool
video
Get the aspect ratio of a window's client area.
Get the size of a window's borders (decorations) around the client area.
sdlGetWindowDisplayScale (Pointer <SdlWindow window → double
video
Get the content display scale relative to a window's pixel size.
sdlGetWindowFlags (Pointer <SdlWindow window → int
video
Get the window flags.
sdlGetWindowFromEvent (Pointer <SdlEvent event → Pointer <SdlWindow
events
Get window associated with an event.
sdlGetWindowFromId (int id → Pointer <SdlWindow
video
Get a window from a stored ID.
sdlGetWindowFullscreenMode (Pointer <SdlWindow window → Pointer <SdlDisplayMode
video
Query the display mode to use when a window is visible at fullscreen.
sdlGetWindowIccProfile (Pointer <SdlWindow window , Pointer <Uint32 size → Pointer <NativeType
video
Get the raw ICC profile data for the screen the window is currently on.
sdlGetWindowId (Pointer <SdlWindow window → int
video
Get the numeric ID of a window.
sdlGetWindowKeyboardGrab (Pointer <SdlWindow window → bool
video
Get a window's keyboard grab mode.
sdlGetWindowMaximumSize (Pointer <SdlWindow window , Pointer <Int32 w , Pointer <Int32 h → bool
video
Get the maximum size of a window's client area.
sdlGetWindowMinimumSize (Pointer <SdlWindow window , Pointer <Int32 w , Pointer <Int32 h → bool
video
Get the minimum size of a window's client area.
sdlGetWindowMouseGrab (Pointer <SdlWindow window → bool
video
Get a window's mouse grab mode.
sdlGetWindowMouseRect (Pointer <SdlWindow window → Pointer <SdlRect
video
Get the mouse confinement rectangle of a window.
sdlGetWindowOpacity (Pointer <SdlWindow window → double
video
Get the opacity of a window.
sdlGetWindowParent (Pointer <SdlWindow window → Pointer <SdlWindow
video
Get parent of a window.
sdlGetWindowPixelDensity (Pointer <SdlWindow window → double
video
Get the pixel density of a window.
sdlGetWindowPixelFormat (Pointer <SdlWindow window → int
video
Get the pixel format associated with the window.
sdlGetWindowPosition (Pointer <SdlWindow window , Pointer <Int32 x , Pointer <Int32 y → bool
video
Get the position of a window.
sdlGetWindowProgressState (Pointer <SdlWindow window → int
video
Get the state of the progress bar for the given window’s taskbar icon.
sdlGetWindowProgressValue (Pointer <SdlWindow window → double
video
Get the value of the progress bar for the given window’s taskbar icon.
sdlGetWindowProperties (Pointer <SdlWindow window → int
video
Get the properties associated with a window.
sdlGetWindowRelativeMouseMode (Pointer <SdlWindow window → bool
mouse
Query whether relative mouse mode is enabled for a window.
sdlGetWindows (Pointer <Int32 count → Pointer <Pointer <SdlWindow
video
Get a list of valid windows.
sdlGetWindowSafeArea (Pointer <SdlWindow window , Pointer <SdlRect rect → bool
video
Get the safe area for this window.
sdlGetWindowSize (Pointer <SdlWindow window , Pointer <Int32 w , Pointer <Int32 h → bool
video
Get the size of a window's client area.
sdlGetWindowSizeInPixels (Pointer <SdlWindow window , Pointer <Int32 w , Pointer <Int32 h → bool
video
Get the size of a window's client area, in pixels.
sdlGetWindowSurface (Pointer <SdlWindow window → Pointer <SdlSurface
video
Get the SDL surface associated with the window.
sdlGetWindowSurfaceVSync (Pointer <SdlWindow window , Pointer <Int32 vsync → bool
video
Get VSync for the window surface.
sdlGetWindowTitle (Pointer <SdlWindow window → String ?
video
Get the title of a window.
sdlGlCreateContext (Pointer <SdlWindow window → Pointer <SdlGlContext
video
Create an OpenGL context for an OpenGL window, and make it current.
sdlGlDestroyContext (Pointer <SdlGlContext context → bool
video
Delete an OpenGL context.
sdlGlExtensionSupported (String ?extension → bool
video
Check if an OpenGL extension is supported for the current context.
sdlGlGetAttribute (int attr , Pointer <Int32 value → bool
video
Get the actual value for an attribute from the current context.
sdlGlGetCurrentContext ()
→ Pointer <SdlGlContext
video
Get the currently active OpenGL context.
sdlGlGetCurrentWindow ()
→ Pointer <SdlWindow
video
Get the currently active OpenGL window.
sdlGlGetProcAddress (String ?proc → Pointer <NativeType
video
Get an OpenGL function by name.
sdlGlGetProcAddressEx (String proc → SDLglproc
sdlGlGetSwapInterval (Pointer <Int32 interval → bool
video
Get the swap interval for the current OpenGL context.
sdlGlLoadLibrary (String ?path → bool
video
Dynamically load an OpenGL library.
sdlGlMakeCurrent (Pointer <SdlWindow window , Pointer <SdlGlContext context → bool
video
Set up an OpenGL context for rendering into an OpenGL window.
sdlGlobDirectory (String ?path , String ?pattern , int flags , Pointer <Int32 count → Pointer <Pointer <Int8
filesystem
Enumerate a directory tree, filtered by pattern, and return a list.
sdlGlobStorageDirectory (Pointer <SdlStorage storage , String ?path , String ?pattern , int flags , Pointer <Int32 count → Pointer <Pointer <Int8
storage
Enumerate a directory tree, filtered by pattern, and return a list.
sdlGlResetAttributes ()
→ void
video
Reset all previously set OpenGL context attributes to their default values.
sdlGlSetAttribute (int attr , int value → bool
video
Set an OpenGL window attribute before window creation.
sdlGlSetSwapInterval (int interval → bool
video
Set the swap interval for the current OpenGL context.
sdlGlSwapWindow (Pointer <SdlWindow window → bool
video
Update a window with OpenGL rendering.
sdlGlUnloadLibrary ()
→ void
video
Unload the OpenGL library previously loaded by SDL_GL_LoadLibrary().
sdlGpuSupportsProperties (int props → bool
gpu
Checks for GPU runtime support.
sdlGpuSupportsShaderFormats (int formatFlags , String ?name → bool
gpu
Checks for GPU runtime support.
sdlGpuTextureFormatTexelBlockSize (int format → int
gpu
Obtains the texel block size for a texture format.
sdlGpuTextureSupportsFormat (Pointer <SdlGpuDevice device , int format , int type , int usage → bool
gpu
Determines whether a texture format is supported for a given type and
usage.
sdlGpuTextureSupportsSampleCount (Pointer <SdlGpuDevice device , int format , int sampleCount → bool
gpu
Determines if a sample count for a texture format is supported.
sdlGuidToString (SdlGuid guid , Pointer <Int8 pszGuid , int cbGuid → void
guid
Get an ASCII string representation for a given SDL_GUID.
sdlHapticEffectSupported (Pointer <SdlHaptic haptic , Pointer <SdlHapticEffect effect → bool
haptic
Check to see if an effect is supported by a haptic device.
sdlHapticRumbleSupported (Pointer <SdlHaptic haptic → bool
haptic
Check whether rumble is supported on a haptic device.
sdlHasAltiVec ()
→ bool
cpuinfo
Determine whether the CPU has AltiVec features.
sdlHasArmsimd ()
→ bool
cpuinfo
Determine whether the CPU has ARM SIMD (ARMv6) features.
sdlHasAvx ()
→ bool
cpuinfo
Determine whether the CPU has AVX features.
sdlHasAvx2 ()
→ bool
cpuinfo
Determine whether the CPU has AVX2 features.
sdlHasAvx512F ()
→ bool
cpuinfo
Determine whether the CPU has AVX-512F (foundation) features.
sdlHasClipboardData (String ?mimeType → bool
clipboard
Query whether there is data in the clipboard for the provided mime type.
sdlHasClipboardText ()
→ bool
clipboard
Query whether the clipboard exists and contains a non-empty text string.
sdlHasEvent (int type → bool
events
Check for the existence of a certain event type in the event queue.
sdlHasEvents (int minType , int maxType → bool
events
Check for the existence of certain event types in the event queue.
sdlHasGamepad ()
→ bool
gamepad
Return whether a gamepad is currently connected.
sdlHasJoystick ()
→ bool
joystick
Return whether a joystick is currently connected.
sdlHasKeyboard ()
→ bool
keyboard
Return whether a keyboard is currently connected.
sdlHasLasx ()
→ bool
cpuinfo
Determine whether the CPU has LASX (LOONGARCH SIMD) features.
sdlHasLsx ()
→ bool
cpuinfo
Determine whether the CPU has LSX (LOONGARCH SIMD) features.
sdlHasMmx ()
→ bool
cpuinfo
Determine whether the CPU has MMX features.
sdlHasMouse ()
→ bool
mouse
Return whether a mouse is currently connected.
sdlHasNeon ()
→ bool
cpuinfo
Determine whether the CPU has NEON (ARM SIMD) features.
sdlHasPrimarySelectionText ()
→ bool
clipboard
Query whether the primary selection exists and contains a non-empty text
string.
sdlHasProperty (int props , String ?name → bool
properties
Return whether a property exists in a group of properties.
sdlHasRectIntersection (Pointer <SdlRect a , Pointer <SdlRect b → bool
rect
Determine whether two rectangles intersect.
sdlHasRectIntersectionFloat (Pointer <SdlFRect a , Pointer <SdlFRect b → bool
rect
Determine whether two rectangles intersect with float precision.
sdlHasScreenKeyboardSupport ()
→ bool
keyboard
Check whether the platform has screen keyboard support.
sdlHasSse ()
→ bool
cpuinfo
Determine whether the CPU has SSE features.
sdlHasSse2 ()
→ bool
cpuinfo
Determine whether the CPU has SSE2 features.
sdlHasSse3 ()
→ bool
cpuinfo
Determine whether the CPU has SSE3 features.
sdlHasSse41 ()
→ bool
cpuinfo
Determine whether the CPU has SSE4.1 features.
sdlHasSse42 ()
→ bool
cpuinfo
Determine whether the CPU has SSE4.2 features.
sdlHidBleScan (bool active → void
hidapi
Start or stop a BLE scan on iOS and tvOS to pair Steam Controllers.
sdlHidClose (Pointer <SdlHidDevice dev → int
hidapi
Close a HID device.
sdlHidDeviceChangeCount ()
→ int
hidapi
Check to see if devices may have been added or removed.
sdlHideCursor ()
→ bool
mouse
Hide the cursor.
sdlHidEnumerate (int vendorId , int productId → Pointer <SdlHidDeviceInfo
hidapi
Enumerate the HID Devices.
sdlHideWindow (Pointer <SdlWindow window → bool
video
Hide a window.
sdlHidExit ()
→ int
hidapi
Finalize the HIDAPI library.
sdlHidFreeEnumeration (Pointer <SdlHidDeviceInfo devs → void
hidapi
Free an enumeration linked list.
sdlHidGetDeviceInfo (Pointer <SdlHidDevice dev → Pointer <SdlHidDeviceInfo
hidapi
Get the device info from a HID device.
sdlHidGetFeatureReport (Pointer <SdlHidDevice dev , Pointer <Uint8 data , int length → int
hidapi
Get a feature report from a HID device.
sdlHidGetIndexedString (Pointer <SdlHidDevice dev , int stringIndex , Pointer <Int16 string , int maxlen → int
hidapi
Get a string from a HID device, based on its string index.
sdlHidGetInputReport (Pointer <SdlHidDevice dev , Pointer <Uint8 data , int length → int
hidapi
Get an input report from a HID device.
sdlHidGetManufacturerString (Pointer <SdlHidDevice dev , Pointer <Int16 string , int maxlen → int
hidapi
Get The Manufacturer String from a HID device.
sdlHidGetProductString (Pointer <SdlHidDevice dev , Pointer <Int16 string , int maxlen → int
hidapi
Get The Product String from a HID device.
sdlHidGetProperties (Pointer <SdlHidDevice dev → int
hidapi
Get the properties associated with an SDL_hid_device.
sdlHidGetReportDescriptor (Pointer <SdlHidDevice dev , Pointer <Uint8 buf , int bufSize → int
hidapi
Get a report descriptor from a HID device.
sdlHidGetSerialNumberString (Pointer <SdlHidDevice dev , Pointer <Int16 string , int maxlen → int
hidapi
Get The Serial Number String from a HID device.
sdlHidInit ()
→ int
hidapi
Initialize the HIDAPI library.
sdlHidOpen (int vendorId , int productId , Pointer <Int16 serialNumber → Pointer <SdlHidDevice
hidapi
Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally
a serial number.
sdlHidOpenPath (String ?path → Pointer <SdlHidDevice
hidapi
Open a HID device by its path name.
sdlHidRead (Pointer <SdlHidDevice dev , Pointer <Uint8 data , int length → int
hidapi
Read an Input report from a HID device.
sdlHidReadTimeout (Pointer <SdlHidDevice dev , Pointer <Uint8 data , int length , int milliseconds → int
hidapi
Read an Input report from a HID device with timeout.
sdlHidSendFeatureReport (Pointer <SdlHidDevice dev , Pointer <Uint8 data , int length → int
hidapi
Send a Feature report to the device.
sdlHidSetNonblocking (Pointer <SdlHidDevice dev , int nonblock → int
hidapi
Set the device handle to be non-blocking.
sdlHidWrite (Pointer <SdlHidDevice dev , Pointer <Uint8 data , int length → int
hidapi
Write an Output report to a HID device.
sdlIconv (Pointer <SdlIconvT cd , Pointer <Pointer <Int8 inbuf , Pointer <Uint32 inbytesleft , Pointer <Pointer <Int8 outbuf , Pointer <Uint32 outbytesleft → int
stdinc
This function converts text between encodings, reading from and writing to
a buffer.
sdlIconvClose (Pointer <SdlIconvT cd → int
stdinc
This function frees a context used for character set conversion.
sdlIconvOpen (String ?tocode , String ?fromcode → Pointer <SdlIconvT
stdinc
This function allocates a context for the specified character set
conversion.
sdlIconvString (String ?tocode , String ?fromcode , String ?inbuf , int inbytesleft → Pointer <Int8
stdinc
Helper function to convert a string's encoding in one call.
sdlIconvUtf8Locate (String s → Pointer <Int8
const SDL_iconv_utf8_locale = (S) SDL_iconv_string('', 'UTF-8', S, SDL_strlen(S)+1);
sdlIconvUtf8Ucs2 (String s → Pointer <Uint16
const SDL_iconv_utf8_ucs2 = (S) (Uint16 *)SDL_iconv_string('UCS-2-INTERNAL', 'UTF-8', S, SDL_strlen(S)+1);
sdlIconvUtf8Ucs4 (String s → Pointer <Uint32
const SDL_iconv_utf8_ucs4 = (S) (Uint32 *)SDL_iconv_string('UCS-4-INTERNAL', 'UTF-8', S, SDL_strlen(S)+1);
sdlInit (int flags → bool
init
Initialize the SDL library.
sdlInitHapticRumble (Pointer <SdlHaptic haptic → bool
haptic
Initialize a haptic device for simple rumble playback.
sdlInitSubSystem (int flags → bool
init
Compatibility function to initialize the SDL library.
sdlInsertGpuDebugLabel (Pointer <SdlGpuCommandBuffer commandBuffer , String ?text → void
gpu
Inserts an arbitrary string label into the command buffer callstream.
sdlInsertTrayEntryAt (int pos , String ?label , int flags → Pointer <SdlTrayEntry
tray
Insert a tray entry at a given position.
sdlIoFromConstMem (Pointer <NativeType mem , int size → Pointer <SdlIoStream
iostream
Use this function to prepare a read-only memory buffer for use with
SDL_IOStream.
sdlIoFromDynamicMem ()
→ Pointer <SdlIoStream
iostream
Use this function to create an SDL_IOStream that is backed by dynamically
allocated memory.
sdlIoFromFile (String ?file , String ?mode → Pointer <SdlIoStream
iostream
Use this function to create a new SDL_IOStream structure for reading from
and/or writing to a named file.
sdlIoFromMem (Pointer <NativeType mem , int size → Pointer <SdlIoStream
iostream
Use this function to prepare a read-write memory buffer for use with
SDL_IOStream.
sdlIOprintf (Pointer <SdlIoStream context , String ?fmt → int
iostream
Print to an SDL_IOStream data stream.
sdlIOvprintf (Pointer <SdlIoStream context , String ?fmt → int
iostream
Print to an SDL_IOStream data stream.
sdlIsalnum (int x → int
stdinc
Query if a character is alphabetic (a letter) or a number.
sdlIsalpha (int x → int
stdinc
Query if a character is alphabetic (a letter).
sdlIsAudioDevicePhysical (int devid → bool
audio
Determine if an audio device is physical (instead of logical).
sdlIsAudioDevicePlayback (int devid → bool
audio
Determine if an audio device is a playback device (instead of recording).
sdlIsblank (int x → int
stdinc
Report if a character is blank (a space or tab).
sdlIsChromebook ()
→ bool
system
Query if the application is running on a Chromebook.
sdlIscntrl (int x → int
stdinc
Report if a character is a control character.
sdlIsDeXMode ()
→ bool
system
Query if the application is running on a Samsung DeX docking station.
sdlIsdigit (int x → int
stdinc
Report if a character is a numeric digit.
sdlIsGamepad (int instanceId → bool
gamepad
Check if the given joystick is supported by the gamepad interface.
sdlIsgraph (int x → int
stdinc
Report if a character is any "printable" except space.
sdlIsinf (double x → int
stdinc
Return whether the value is infinity.
sdlIsinff (double x → int
stdinc
Return whether the value is infinity.
sdlIsJoystickHaptic (Pointer <SdlJoystick joystick → bool
haptic
Query if a joystick has haptic features.
sdlIsJoystickVirtual (int instanceId → bool
joystick
Query whether or not a joystick is virtual.
sdlIslower (int x → int
stdinc
Report if a character is lower case.
sdlIsMainThread ()
→ bool
init
Return whether this is the main thread.
sdlIsMouseHaptic ()
→ bool
haptic
Query whether or not the current mouse has haptic capabilities.
sdlIsnan (double x → int
stdinc
Return whether the value is NaN.
sdlIsnanf (double x → int
stdinc
Return whether the value is NaN.
sdlIsprint (int x → int
stdinc
Report if a character is "printable".
sdlIspunct (int x → int
stdinc
Report if a character is a punctuation mark.
sdlIsspace (int x → int
stdinc
Report if a character is whitespace.
sdlIsTablet ()
→ bool
system
Query if the current device is a tablet.
sdlIsTv ()
→ bool
system
Query if the current device is a TV.
sdlIsupper (int x → int
stdinc
Report if a character is upper case.
sdlIsxdigit (int x → int
stdinc
Report if a character is a hexadecimal digit.
sdlItoa (int value , Pointer <Int8 str , int radix → Pointer <Int8
stdinc
Convert an integer into a string.
sdlJoystickConnected (Pointer <SdlJoystick joystick → bool
joystick
Get the status of a specified joystick.
sdlJoystickEventsEnabled ()
→ bool
joystick
Query the state of joystick event processing.
sdlKillProcess (Pointer <SdlProcess process , bool force → bool
process
Stop a process.
sdlLltoa (Pointer <NativeType value , Pointer <Int8 str , int radix → Pointer <Int8
stdinc
Convert a long long integer into a string.
sdlLoadBmp (String ?file → Pointer <SdlSurface
surface
Load a BMP image from a file.
sdlLoadBmpIo (Pointer <SdlIoStream src , bool closeio → Pointer <SdlSurface
surface
Load a BMP image from a seekable SDL data stream.
sdlLoadFile (String ?file , Pointer <Uint32 datasize → Pointer <NativeType
iostream
Load all the data from a file path.
sdlLoadFileAsync (String ?file , Pointer <SdlAsyncIoQueue queue , Pointer <NativeType userdata → bool
asyncio
Load all the data from a file path, asynchronously.
sdlLoadFileIo (Pointer <SdlIoStream src , Pointer <Uint32 datasize , bool closeio → Pointer <NativeType
iostream
Load all the data from an SDL data stream.
sdlLoadFunction (Pointer <SdlSharedObject handle , String ?name → Pointer <NativeType
loadso
Look up the address of the named function in a shared object.
sdlLoadObject (String ?sofile → Pointer <SdlSharedObject
loadso
Dynamically load a shared object.
sdlLoadWav (String ?path , Pointer <SdlAudioSpec spec , Pointer <Pointer <Uint8 audioBuf , Pointer <Uint32 audioLen → bool
audio
Loads a WAV from a file path.
sdlLoadWavIo (Pointer <SdlIoStream src , bool closeio , Pointer <SdlAudioSpec spec , Pointer <Pointer <Uint8 audioBuf , Pointer <Uint32 audioLen → bool
audio
Load the audio data of a WAVE file into memory.
sdlLockAudioStream (Pointer <SdlAudioStream stream → bool
audio
Lock an audio stream for serialized access.
sdlLockJoysticks (Pointer <NativeType arg0 → void
joystick
Locking for atomic access to the joystick API.
sdlLockMutex (Pointer <NativeType arg0 → void
mutex
Lock the mutex.
sdlLockProperties (int props → bool
properties
Lock a group of properties.
sdlLockRwLockForReading (Pointer <NativeType arg0 → void
mutex
Lock the read/write lock for read only operations.
sdlLockRwLockForWriting (Pointer <NativeType arg0 → void
mutex
Lock the read/write lock for write operations.
sdlLockSpinlock (Pointer <Int32 lock → void
atomic
Lock a spin lock by setting it to a non-zero value.
sdlLockSurface (Pointer <SdlSurface surface → bool
surface
Set up a surface for directly accessing the pixels.
sdlLockTexture (Pointer <SdlTexture texture , Pointer <SdlRect rect , Pointer <Pointer <NativeType pixels , Pointer <Int32 pitch → bool
render
Lock a portion of the texture for write-only pixel access.
sdlLockTextureToSurface (Pointer <SdlTexture texture , Pointer <SdlRect rect , Pointer <Pointer <SdlSurface surface → bool
render
Lock a portion of the texture for write-only pixel access, and expose
it as a SDL surface.
sdlLog (String ?fmt → void
log
Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO.
sdlLog10 (double x → double
stdinc
Compute the base-10 logarithm of x.
sdlLog10f (double x → double
stdinc
Compute the base-10 logarithm of x.
sdlLogCritical (int category , String ?fmt → void
log
Log a message with SDL_LOG_PRIORITY_CRITICAL.
sdlLogDebug (int category , String ?fmt → void
log
Log a message with SDL_LOG_PRIORITY_DEBUG.
sdlLogError (int category , String ?fmt → void
log
Log a message with SDL_LOG_PRIORITY_ERROR.
sdlLogf (double x → double
stdinc
Compute the natural logarithm of x.
sdlLogInfo (int category , String ?fmt → void
log
Log a message with SDL_LOG_PRIORITY_INFO.
sdlLogMessage (int category , int priority , String ?fmt → void
log
Log a message with the specified category and priority.
sdlLogMessageV (int category , int priority , String ?fmt → void
log
Log a message with the specified category and priority.
sdlLogTrace (int category , String ?fmt → void
log
Log a message with SDL_LOG_PRIORITY_TRACE.
sdlLogVerbose (int category , String ?fmt → void
log
Log a message with SDL_LOG_PRIORITY_VERBOSE.
sdlLogWarn (int category , String ?fmt → void
log
Log a message with SDL_LOG_PRIORITY_WARN.
sdlLround (double x → int
stdinc
Round x to the nearest integer representable as a long
sdlLroundf (double x → int
stdinc
Round x to the nearest integer representable as a long
sdlLtoa (int value , Pointer <Int8 str , int radix → Pointer <Int8
stdinc
Convert a long integer into a string.
sdlMalloc (int size → Pointer <NativeType
stdinc
Allocate uninitialized memory.
sdlMapGpuTransferBuffer (Pointer <SdlGpuDevice device , Pointer <SdlGpuTransferBuffer transferBuffer , bool cycle → Pointer <NativeType
gpu
Maps a transfer buffer into application address space.
sdlMapRgb (Pointer <SdlPixelFormatDetails format , Pointer <SdlPalette palette , int r , int g , int b → int
pixels
Map an RGB triple to an opaque pixel value for a given pixel format.
sdlMapRgba (Pointer <SdlPixelFormatDetails format , Pointer <SdlPalette palette , int r , int g , int b , int a → int
pixels
Map an RGBA quadruple to a pixel value for a given pixel format.
sdlMapSurfaceRgb (Pointer <SdlSurface surface , int r , int g , int b → int
surface
Map an RGB triple to an opaque pixel value for a surface.
sdlMapSurfaceRgba (Pointer <SdlSurface surface , int r , int g , int b , int a → int
surface
Map an RGBA quadruple to a pixel value for a surface.
sdlMaximizeWindow (Pointer <SdlWindow window → bool
video
Request that the window be made as large as possible.
sdlMemcmp (Pointer <NativeType s1 , Pointer <NativeType s2 , int len → int
stdinc
Compare two buffers of memory.
sdlMemcpy (Pointer <NativeType arg0 , Pointer <NativeType arg1 , int len → Pointer <NativeType
stdinc
Copy non-overlapping memory.
sdlMemmove (Pointer <NativeType arg0 , Pointer <NativeType arg1 , int len → Pointer <NativeType
stdinc
Copy memory ranges that might overlap.
sdlMemoryBarrierAcquireFunction ()
→ void
atomic
Insert a memory acquire barrier (function version).
sdlMemoryBarrierReleaseFunction ()
→ void
atomic
Insert a memory release barrier (function version).
sdlMemset (Pointer <NativeType arg0 , int c , int len → Pointer <NativeType
stdinc
Initialize all bytes of buffer of memory to a specific value.
sdlMemset4 (Pointer <NativeType dst , int val , int dwords → Pointer <NativeType
stdinc
Initialize all 32-bit words of buffer of memory to a specific value.
sdlMetalCreateView (Pointer <SdlWindow window → void
metal
Create a CAMetalLayer-backed NSView/UIView and attach it to the specified
window.
sdlMetalDestroyView ()
→ void
metal
Destroy an existing SDL_MetalView object.
sdlMetalGetLayer ()
→ Pointer <NativeType
metal
Get a pointer to the backing CAMetalLayer for the given view.
sdlMinimizeWindow (Pointer <SdlWindow window → bool
video
Request that the window be minimized to an iconic representation.
sdlMixAudio (Pointer <Uint8 dst , Pointer <Uint8 src , int format , int len , double volume → bool
audio
Mix audio data in a specified format.
sdlModf (double x , Pointer <Double y → double
stdinc
Split x into integer and fractional parts
sdlModff (double x , Pointer <Float y → double
stdinc
Split x into integer and fractional parts
sdlMurmur332 (Pointer <NativeType data , int len , int seed → int
stdinc
Calculate a 32-bit MurmurHash3 value for a block of data.
sdlOnApplicationDidChangeStatusBarOrientation ()
→ void
system
Let iOS apps with external event handling report
onApplicationDidChangeStatusBarOrientation.
sdlOnApplicationDidEnterBackground ()
→ void
system
Let iOS apps with external event handling report
onApplicationDidEnterBackground.
sdlOnApplicationDidEnterForeground ()
→ void
system
Let iOS apps with external event handling report
onApplicationDidBecomeActive.
sdlOnApplicationDidReceiveMemoryWarning ()
→ void
system
Let iOS apps with external event handling report
onApplicationDidReceiveMemoryWarning.
sdlOnApplicationWillEnterBackground ()
→ void
system
Let iOS apps with external event handling report
onApplicationWillResignActive.
sdlOnApplicationWillEnterForeground ()
→ void
system
Let iOS apps with external event handling report
onApplicationWillEnterForeground.
sdlOnApplicationWillTerminate ()
→ void
system
Let iOS apps with external event handling report
onApplicationWillTerminate.
sdlOpenAudioDevice (int devid , Pointer <SdlAudioSpec spec → int
audio
Open a specific audio device.
sdlOpenAudioDeviceStream (int devid , Pointer <SdlAudioSpec spec , Pointer <NativeFunction <SdlAudioStreamCallback callback , Pointer <NativeType userdata → Pointer <SdlAudioStream
audio
Convenience function for straightforward audio init for the common case.
sdlOpenCamera (int instanceId , Pointer <SdlCameraSpec spec → Pointer <SdlCamera
camera
Open a video recording device (a "camera").
sdlOpenFileStorage (String ?path → Pointer <SdlStorage
storage
Opens up a container for local filesystem storage.
sdlOpenGamepad (int instanceId → Pointer <SdlGamepad
gamepad
Open a gamepad for use.
sdlOpenHaptic (int instanceId → Pointer <SdlHaptic
haptic
Open a haptic device for use.
sdlOpenHapticFromJoystick (Pointer <SdlJoystick joystick → Pointer <SdlHaptic
haptic
Open a haptic device for use from a joystick device.
sdlOpenHapticFromMouse ()
→ Pointer <SdlHaptic
haptic
Try to open a haptic device from the current mouse.
sdlOpenIo (Pointer <SdlIoStreamInterface iface , Pointer <NativeType userdata → Pointer <SdlIoStream
iostream
Create a custom SDL_IOStream.
sdlOpenJoystick (int instanceId → Pointer <SdlJoystick
joystick
Open a joystick for use.
sdlOpenSensor (int instanceId → Pointer <SdlSensor
sensor
Open a sensor for use.
sdlOpenStorage (Pointer <SdlStorageInterface iface , Pointer <NativeType userdata → Pointer <SdlStorage
storage
Opens up a container using a client-provided storage interface.
sdlOpenTitleStorage (String ?override , int props → Pointer <SdlStorage
storage
Opens up a read-only container for the application's filesystem.
sdlOpenUrl (String ?url → bool
misc
Open a URL/URI in the browser or other appropriate external application.
sdlOpenUserStorage (String ?org , String ?app , int props → Pointer <SdlStorage
storage
Opens up a container for a user's unique read/write filesystem.
sdlOutOfMemory ()
→ bool
error
Set an error indicating that memory allocation failed.
sdlPauseAudioDevice (int devid → bool
audio
Use this function to pause audio playback on a specified device.
sdlPauseAudioStreamDevice (Pointer <SdlAudioStream stream → bool
audio
Use this function to pause audio playback on the audio device associated
with an audio stream.
sdlPauseHaptic (Pointer <SdlHaptic haptic → bool
haptic
Pause a haptic device.
sdlPeepEvents (Pointer <SdlEvent events , int numevents , int action , int minType , int maxType → int
events
Check the event queue for messages and optionally return them.
sdlPlayHapticRumble (Pointer <SdlHaptic haptic , double strength , int length → bool
haptic
Run a simple rumble effect on a haptic device.
sdlPollEvent (Pointer <SdlEvent event → bool
events
Poll for currently pending events.
sdlPopGpuDebugGroup (Pointer <SdlGpuCommandBuffer commandBuffer → void
gpu
Ends the most-recently pushed debug group.
sdlPow (double x , double y → double
stdinc
Raise x to the power y
sdlPowf (double x , double y → double
stdinc
Raise x to the power y
sdlPremultiplyAlpha (int width , int height , int srcFormat , Pointer <NativeType src , int srcPitch , int dstFormat , Pointer <NativeType dst , int dstPitch , bool linear → bool
surface
Premultiply the alpha on a block of pixels.
sdlPremultiplySurfaceAlpha (Pointer <SdlSurface surface , bool linear → bool
surface
Premultiply the alpha in a surface.
sdlPumpEvents ()
→ void
events
Pump the event loop, gathering events from the input devices.
sdlPushEvent (Pointer <SdlEvent event → bool
events
Add an event to the event queue.
sdlPushGpuComputeUniformData (Pointer <SdlGpuCommandBuffer commandBuffer , int slotIndex , Pointer <NativeType data , int length → void
gpu
Pushes data to a uniform slot on the command buffer.
sdlPushGpuDebugGroup (Pointer <SdlGpuCommandBuffer commandBuffer , String ?name → void
gpu
Begins a debug group with an arbitrary name.
sdlPushGpuFragmentUniformData (Pointer <SdlGpuCommandBuffer commandBuffer , int slotIndex , Pointer <NativeType data , int length → void
gpu
Pushes data to a fragment uniform slot on the command buffer.
sdlPushGpuVertexUniformData (Pointer <SdlGpuCommandBuffer commandBuffer , int slotIndex , Pointer <NativeType data , int length → void
gpu
Pushes data to a vertex uniform slot on the command buffer.
sdlPutAudioStreamData (Pointer <SdlAudioStream stream , Pointer <NativeType buf , int len → bool
audio
Add data to the stream.
sdlPutAudioStreamDataNoCopy (Pointer <SdlAudioStream stream , Pointer <NativeType buf , int len , Pointer <NativeFunction <SdlAudioStreamDataCompleteCallback callback , Pointer <NativeType userdata → bool
audio
Add external data to an audio stream without copying it.
sdlPutAudioStreamPlanarData (Pointer <SdlAudioStream stream , Pointer <Pointer <NativeType channelBuffers , int numChannels , int numSamples → bool
audio
Add data to the stream with each channel in a separate array.
sdlQsort (Pointer <NativeType base , int nmemb , int size , Pointer <NativeFunction <SdlCompareCallback compare → void
stdinc
Sort an array.
sdlQsortR (Pointer <NativeType base , int nmemb , int size , Pointer <NativeFunction <SdlCompareCallbackR compare , Pointer <NativeType userdata → void
stdinc
Sort an array, passing a userdata pointer to the compare function.
sdlQueryGpuFence (Pointer <SdlGpuDevice device , Pointer <SdlGpuFence fence → bool
gpu
Checks the status of a fence.
sdlQuit ()
→ void
init
Clean up all initialized subsystems.
sdlQuitSubSystem (int flags → void
init
Shut down specific SDL subsystems.
sdlRaiseWindow (Pointer <SdlWindow window → bool
video
Request that a window be raised above other windows and gain the input
focus.
sdlRand (int n → int
stdinc
Generate a pseudo-random number less than n for positive n
sdlRandBits ()
→ int
stdinc
Generate 32 pseudo-random bits.
sdlRandBitsR (Pointer <Uint64 state → int
stdinc
Generate 32 pseudo-random bits.
sdlRandf ()
→ double
stdinc
Generate a uniform pseudo-random floating point number less than 1.0
sdlRandfR (Pointer <Uint64 state → double
stdinc
Generate a uniform pseudo-random floating point number less than 1.0
sdlRandR (Pointer <Uint64 state , int n → int
stdinc
Generate a pseudo-random number less than n for positive n
sdlReadAsyncIo (Pointer <SdlAsyncIo asyncio , Pointer <NativeType ptr , int offset , int size , Pointer <SdlAsyncIoQueue queue , Pointer <NativeType userdata → bool
asyncio
Start an async read.
sdlReadIo (Pointer <SdlIoStream context , Pointer <NativeType ptr , int size → int
iostream
Read from a data source.
sdlReadProcess (Pointer <SdlProcess process , Pointer <Uint32 datasize , Pointer <Int32 exitcode → Pointer <NativeType
process
Read all the output from a process.
sdlReadS16Be (Pointer <SdlIoStream src , Pointer <Int16 value → bool
iostream
Use this function to read 16 bits of big-endian data from an SDL_IOStream
and return in native format.
sdlReadS16Le (Pointer <SdlIoStream src , Pointer <Int16 value → bool
iostream
Use this function to read 16 bits of little-endian data from an
SDL_IOStream and return in native format.
sdlReadS32Be (Pointer <SdlIoStream src , Pointer <Int32 value → bool
iostream
Use this function to read 32 bits of big-endian data from an SDL_IOStream
and return in native format.
sdlReadS32Le (Pointer <SdlIoStream src , Pointer <Int32 value → bool
iostream
Use this function to read 32 bits of little-endian data from an
SDL_IOStream and return in native format.
sdlReadS64Be (Pointer <SdlIoStream src , Pointer <Int64 value → bool
iostream
Use this function to read 64 bits of big-endian data from an SDL_IOStream
and return in native format.
sdlReadS64Le (Pointer <SdlIoStream src , Pointer <Int64 value → bool
iostream
Use this function to read 64 bits of little-endian data from an
SDL_IOStream and return in native format.
sdlReadS8 (Pointer <SdlIoStream src , Pointer <Int8 value → bool
iostream
Use this function to read a signed byte from an SDL_IOStream.
sdlReadStorageFile (Pointer <SdlStorage storage , String ?path , Pointer <NativeType destination , int length → bool
storage
Synchronously read a file from a storage container into a client-provided
buffer.
sdlReadSurfacePixel (Pointer <SdlSurface surface , int x , int y , Pointer <Uint8 r , Pointer <Uint8 g , Pointer <Uint8 b , Pointer <Uint8 a → bool
surface
Retrieves a single pixel from a surface.
sdlReadSurfacePixelFloat (Pointer <SdlSurface surface , int x , int y , Pointer <Float r , Pointer <Float g , Pointer <Float b , Pointer <Float a → bool
surface
Retrieves a single pixel from a surface.
sdlReadU16Be (Pointer <SdlIoStream src , Pointer <Uint16 value → bool
iostream
Use this function to read 16 bits of big-endian data from an SDL_IOStream
and return in native format.
sdlReadU16Le (Pointer <SdlIoStream src , Pointer <Uint16 value → bool
iostream
Use this function to read 16 bits of little-endian data from an
SDL_IOStream and return in native format.
sdlReadU32Be (Pointer <SdlIoStream src , Pointer <Uint32 value → bool
iostream
Use this function to read 32 bits of big-endian data from an SDL_IOStream
and return in native format.
sdlReadU32Le (Pointer <SdlIoStream src , Pointer <Uint32 value → bool
iostream
Use this function to read 32 bits of little-endian data from an
SDL_IOStream and return in native format.
sdlReadU64Be (Pointer <SdlIoStream src , Pointer <Uint64 value → bool
iostream
Use this function to read 64 bits of big-endian data from an SDL_IOStream
and return in native format.
sdlReadU64Le (Pointer <SdlIoStream src , Pointer <Uint64 value → bool
iostream
Use this function to read 64 bits of little-endian data from an
SDL_IOStream and return in native format.
sdlReadU8 (Pointer <SdlIoStream src , Pointer <Uint8 value → bool
iostream
Use this function to read a byte from an SDL_IOStream.
sdlRegisterApp (String ?name , int style , Pointer <NativeType hInst → bool
main
Register a win32 window class for SDL's use.
sdlRegisterEvents (int numevents → int
events
Allocate a set of user-defined events, and return the beginning event
number for that set of events.
sdlReleaseCameraFrame (Pointer <SdlCamera camera , Pointer <SdlSurface frame → void
camera
Release a frame of video acquired from a camera.
sdlReleaseGpuBuffer (Pointer <SdlGpuDevice device , Pointer <SdlGpuBuffer buffer → void
gpu
Frees the given buffer as soon as it is safe to do so.
sdlReleaseGpuComputePipeline (Pointer <SdlGpuDevice device , Pointer <SdlGpuComputePipeline computePipeline → void
gpu
Frees the given compute pipeline as soon as it is safe to do so.
sdlReleaseGpuFence (Pointer <SdlGpuDevice device , Pointer <SdlGpuFence fence → void
gpu
Releases a fence obtained from SDL_SubmitGPUCommandBufferAndAcquireFence.
sdlReleaseGpuGraphicsPipeline (Pointer <SdlGpuDevice device , Pointer <SdlGpuGraphicsPipeline graphicsPipeline → void
gpu
Frees the given graphics pipeline as soon as it is safe to do so.
sdlReleaseGpuSampler (Pointer <SdlGpuDevice device , Pointer <SdlGpuSampler sampler → void
gpu
Frees the given sampler as soon as it is safe to do so.
sdlReleaseGpuShader (Pointer <SdlGpuDevice device , Pointer <SdlGpuShader shader → void
gpu
Frees the given shader as soon as it is safe to do so.
sdlReleaseGpuTexture (Pointer <SdlGpuDevice device , Pointer <SdlGpuTexture texture → void
gpu
Frees the given texture as soon as it is safe to do so.
sdlReleaseGpuTransferBuffer (Pointer <SdlGpuDevice device , Pointer <SdlGpuTransferBuffer transferBuffer → void
gpu
Frees the given transfer buffer as soon as it is safe to do so.
sdlReleaseWindowFromGpuDevice (Pointer <SdlGpuDevice device , Pointer <SdlWindow window → void
gpu
Unclaims a window, destroying its swapchain structure.
sdlReloadGamepadMappings ()
→ bool
gamepad
Reinitialize the SDL mapping database to its initial state.
sdlRemoveEventWatch (Pointer <NativeFunction <SdlEventFilter filter , Pointer <NativeType userdata → void
events
Remove an event watch callback added with SDL_AddEventWatch().
sdlRemoveHintCallback (String ?name , Pointer <NativeFunction <SdlHintCallback callback , Pointer <NativeType userdata → void
hints
Remove a function watching a particular hint.
sdlRemovePath (String ?path → bool
filesystem
Remove a file or an empty directory.
sdlRemoveStoragePath (Pointer <SdlStorage storage , String ?path → bool
storage
Remove a file or an empty directory in a writable storage container.
sdlRemoveSurfaceAlternateImages (Pointer <SdlSurface surface → void
surface
Remove all alternate versions of a surface.
sdlRemoveTimer (int id → bool
timer
Remove a timer created with SDL_AddTimer().
sdlRemoveTrayEntry (Pointer <SdlTrayEntry entry → void
tray
Removes a tray entry.
sdlRenamePath (String ?oldpath , String ?newpath → bool
filesystem
Rename a file or directory.
sdlRenameStoragePath (Pointer <SdlStorage storage , String ?oldpath , String ?newpath → bool
storage
Rename a file or directory in a writable storage container.
sdlRenderClear (Pointer <SdlRenderer renderer → bool
render
Clear the current rendering target with the drawing color.
sdlRenderClipEnabled (Pointer <SdlRenderer renderer → bool
render
Get whether clipping is enabled on the given render target.
sdlRenderCoordinatesFromWindow (Pointer <SdlRenderer renderer , double windowX , double windowY , Pointer <Float x , Pointer <Float y → bool
render
Get a point in render coordinates when given a point in window coordinates.
sdlRenderCoordinatesToWindow (Pointer <SdlRenderer renderer , double x , double y , Pointer <Float windowX , Pointer <Float windowY → bool
render
Get a point in window coordinates when given a point in render coordinates.
sdlRenderDebugText (Pointer <SdlRenderer renderer , double x , double y , String ?str → bool
render
Draw debug text to an SDL_Renderer.
sdlRenderDebugTextFormat (Pointer <SdlRenderer renderer , double x , double y , String ?fmt → bool
render
Draw debug text to an SDL_Renderer.
sdlRenderFillRect (Pointer <SdlRenderer renderer , Pointer <SdlFRect rect → bool
render
Fill a rectangle on the current rendering target with the drawing color at
subpixel precision.
sdlRenderFillRects (Pointer <SdlRenderer renderer , Pointer <SdlFRect rects , int count → bool
render
Fill some number of rectangles on the current rendering target with the
drawing color at subpixel precision.
sdlRenderGeometry (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <SdlVertex vertices , int numVertices , Pointer <Int32 indices , int numIndices → bool
render
Render a list of triangles, optionally using a texture and indices into the
vertex array Color and alpha modulation is done per vertex
(SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).
sdlRenderGeometryRaw (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <Float xy , int xyStride , Pointer <SdlFColor color , int colorStride , Pointer <Float uv , int uvStride , int numVertices , Pointer <NativeType indices , int numIndices , int sizeIndices → bool
render
Render a list of triangles, optionally using a texture and indices into the
vertex arrays Color and alpha modulation is done per vertex
(SDL_SetTextureColorMod and SDL_SetTextureAlphaMod are ignored).
sdlRenderLine (Pointer <SdlRenderer renderer , double x1 , double y1 , double x2 , double y2 → bool
render
Draw a line on the current rendering target at subpixel precision.
sdlRenderLines (Pointer <SdlRenderer renderer , Pointer <SdlFPoint points , int count → bool
render
Draw a series of connected lines on the current rendering target at
subpixel precision.
sdlRenderPoint (Pointer <SdlRenderer renderer , double x , double y → bool
render
Draw a point on the current rendering target at subpixel precision.
sdlRenderPoints (Pointer <SdlRenderer renderer , Pointer <SdlFPoint points , int count → bool
render
Draw multiple points on the current rendering target at subpixel precision.
sdlRenderPresent (Pointer <SdlRenderer renderer → bool
render
Update the screen with any rendering performed since the previous call.
sdlRenderReadPixels (Pointer <SdlRenderer renderer , Pointer <SdlRect rect → Pointer <SdlSurface
render
Read pixels from the current rendering target.
sdlRenderRect (Pointer <SdlRenderer renderer , Pointer <SdlFRect rect → bool
render
Draw a rectangle on the current rendering target at subpixel precision.
sdlRenderRects (Pointer <SdlRenderer renderer , Pointer <SdlFRect rects , int count → bool
render
Draw some number of rectangles on the current rendering target at subpixel
precision.
sdlRenderTexture (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <SdlFRect srcrect , Pointer <SdlFRect dstrect → bool
render
Copy a portion of the texture to the current rendering target at subpixel
precision.
sdlRenderTexture9Grid (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <SdlFRect srcrect , double leftWidth , double rightWidth , double topHeight , double bottomHeight , double scale , Pointer <SdlFRect dstrect → bool
render
Perform a scaled copy using the 9-grid algorithm to the current rendering
target at subpixel precision.
sdlRenderTexture9GridTiled (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <SdlFRect srcrect , double leftWidth , double rightWidth , double topHeight , double bottomHeight , double scale , Pointer <SdlFRect dstrect , double tileScale → bool
render
Perform a scaled copy using the 9-grid algorithm to the current rendering
target at subpixel precision.
sdlRenderTextureAffine (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <SdlFRect srcrect , Pointer <SdlFPoint origin , Pointer <SdlFPoint right , Pointer <SdlFPoint down → bool
render
Copy a portion of the source texture to the current rendering target, with
affine transform, at subpixel precision.
sdlRenderTextureRotated (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <SdlFRect srcrect , Pointer <SdlFRect dstrect , double angle , Pointer <SdlFPoint center , int flip → bool
render
Copy a portion of the source texture to the current rendering target, with
rotation and flipping, at subpixel precision.
sdlRenderTextureTiled (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture , Pointer <SdlFRect srcrect , double scale , Pointer <SdlFRect dstrect → bool
render
Tile a portion of the texture to the current rendering target at subpixel
precision.
sdlRenderViewportSet (Pointer <SdlRenderer renderer → bool
render
Return whether an explicit rectangle was set as the viewport.
sdlRequestAndroidPermission (String ?permission , Pointer <NativeFunction <SdlRequestAndroidPermissionCallback cb , Pointer <NativeType userdata → bool
system
Request permissions at runtime, asynchronously.
sdlResetAssertionReport ()
→ void
assert
Clear the list of all assertion failures.
sdlResetHint (String ?name → bool
hints
Reset a hint to the default value.
sdlResetHints ()
→ void
hints
Reset all hints to the default values.
sdlResetKeyboard ()
→ void
keyboard
Clear the state of the keyboard.
sdlResetLogPriorities ()
→ void
log
Reset all priorities to default.
sdlRestoreWindow (Pointer <SdlWindow window → bool
video
Request that the size and position of a minimized or maximized window be
restored.
sdlResumeAudioDevice (int devid → bool
audio
Use this function to unpause audio playback on a specified device.
sdlResumeAudioStreamDevice (Pointer <SdlAudioStream stream → bool
audio
Use this function to unpause audio playback on the audio device associated
with an audio stream.
sdlResumeHaptic (Pointer <SdlHaptic haptic → bool
haptic
Resume a haptic device.
sdlRound (double x → double
stdinc
Round x to the nearest integer.
sdlRoundf (double x → double
stdinc
Round x to the nearest integer.
sdlRumbleGamepad (Pointer <SdlGamepad gamepad , int lowFrequencyRumble , int highFrequencyRumble , int durationMs → bool
gamepad
Start a rumble effect on a gamepad.
sdlRumbleGamepadTriggers (Pointer <SdlGamepad gamepad , int leftRumble , int rightRumble , int durationMs → bool
gamepad
Start a rumble effect in the gamepad's triggers.
sdlRumbleJoystick (Pointer <SdlJoystick joystick , int lowFrequencyRumble , int highFrequencyRumble , int durationMs → bool
joystick
Start a rumble effect.
sdlRumbleJoystickTriggers (Pointer <SdlJoystick joystick , int leftRumble , int rightRumble , int durationMs → bool
joystick
Start a rumble effect in the joystick's triggers.
sdlRunApp (int argc , Pointer <Pointer <Int8 argv , Pointer <NativeFunction <SdlMainFunc mainFunction , Pointer <NativeType reserved → int
main
Initializes and launches an SDL application, by doing platform-specific
initialization before calling your mainFunction and cleanups after it
returns, if that is needed for a specific platform, otherwise it just calls
mainFunction.
sdlRunHapticEffect (Pointer <SdlHaptic haptic , int effect , int iterations → bool
haptic
Run the haptic effect on its associated haptic device.
sdlRunOnMainThread (Pointer <NativeFunction <SdlMainThreadCallback callback , Pointer <NativeType userdata , bool waitComplete → bool
init
Call a function on the main thread during event processing.
sdlSaveBmp (Pointer <SdlSurface surface , String ?file → bool
surface
Save a surface to a file.
sdlSaveBmpIo (Pointer <SdlSurface surface , Pointer <SdlIoStream dst , bool closeio → bool
surface
Save a surface to a seekable SDL data stream in BMP format.
sdlSaveFile (String ?file , Pointer <NativeType data , int datasize → bool
iostream
Save all the data into a file path.
sdlSaveFileIo (Pointer <SdlIoStream src , Pointer <NativeType data , int datasize , bool closeio → bool
iostream
Save all the data into an SDL data stream.
sdlScalbn (double x , int n → double
stdinc
Scale x by an integer power of two.
sdlScalbnf (double x , int n → double
stdinc
Scale x by an integer power of two.
sdlScaleSurface (Pointer <SdlSurface surface , int width , int height , int scaleMode → Pointer <SdlSurface
surface
Creates a new surface identical to the existing surface, scaled to the
desired size.
sdlScancodeToKeycode (int x → int
sdlScreenKeyboardShown (Pointer <SdlWindow window → bool
keyboard
Check whether the screen keyboard is shown for given window.
sdlScreenSaverEnabled ()
→ bool
video
Check whether the screensaver is currently enabled.
sdlSeekIo (Pointer <SdlIoStream context , int offset , int whence → int
iostream
Seek within an SDL_IOStream data stream.
sdlSendAndroidBackButton ()
→ void
system
Trigger the Android system back button behavior.
sdlSendAndroidMessage (int command , int param → bool
system
Send a user command to SDLActivity.
sdlSendGamepadEffect (Pointer <SdlGamepad gamepad , Pointer <NativeType data , int size → bool
gamepad
Send a gamepad specific effect packet.
sdlSendJoystickEffect (Pointer <SdlJoystick joystick , Pointer <NativeType data , int size → bool
joystick
Send a joystick specific effect packet.
sdlSendJoystickVirtualSensorData (Pointer <SdlJoystick joystick , int type , int sensorTimestamp , Pointer <Float data , int numValues → bool
joystick
Send a sensor update for an opened virtual joystick.
sdlSetAppMetadata (String ?appname , String ?appversion , String ?appidentifier → bool
init
Specify basic metadata about your app.
sdlSetAppMetadataProperty (String ?name , String ?value → bool
init
Specify metadata about your app through a set of properties.
sdlSetAssertionHandler (Pointer <NativeFunction <SdlAssertionHandler handler , Pointer <NativeType userdata → void
assert
Set an application-defined assertion handler.
sdlSetAtomicInt (Pointer <SdlAtomicInt a , int v → int
atomic
Set an atomic variable to a value.
sdlSetAtomicPointer (Pointer <Pointer <NativeType a , Pointer <NativeType v → Pointer <NativeType
atomic
Set a pointer to a value atomically.
sdlSetAtomicU32 (Pointer <SdlAtomicU32 a , int v → int
atomic
Set an atomic variable to a value.
sdlSetAudioDeviceGain (int devid , double gain → bool
audio
Change the gain of an audio device.
sdlSetAudioPostmixCallback (int devid , Pointer <NativeFunction <SdlAudioPostmixCallback callback , Pointer <NativeType userdata → bool
audio
Set a callback that fires when data is about to be fed to an audio device.
sdlSetAudioStreamFormat (Pointer <SdlAudioStream stream , Pointer <SdlAudioSpec srcSpec , Pointer <SdlAudioSpec dstSpec → bool
audio
Change the input and output formats of an audio stream.
sdlSetAudioStreamFrequencyRatio (Pointer <SdlAudioStream stream , double ratio → bool
audio
Change the frequency ratio of an audio stream.
sdlSetAudioStreamGain (Pointer <SdlAudioStream stream , double gain → bool
audio
Change the gain of an audio stream.
sdlSetAudioStreamGetCallback (Pointer <SdlAudioStream stream , Pointer <NativeFunction <SdlAudioStreamCallback callback , Pointer <NativeType userdata → bool
audio
Set a callback that runs when data is requested from an audio stream.
sdlSetAudioStreamInputChannelMap (Pointer <SdlAudioStream stream , Pointer <Int32 chmap , int count → bool
audio
Set the current input channel map of an audio stream.
sdlSetAudioStreamOutputChannelMap (Pointer <SdlAudioStream stream , Pointer <Int32 chmap , int count → bool
audio
Set the current output channel map of an audio stream.
sdlSetAudioStreamPutCallback (Pointer <SdlAudioStream stream , Pointer <NativeFunction <SdlAudioStreamCallback callback , Pointer <NativeType userdata → bool
audio
Set a callback that runs when data is added to an audio stream.
sdlSetBooleanProperty (int props , String ?name , bool value → bool
properties
Set a boolean property in a group of properties.
sdlSetClipboardData (Pointer <NativeFunction <SdlClipboardDataCallback callback , Pointer <NativeFunction <SdlClipboardCleanupCallback cleanup , Pointer <NativeType userdata , Pointer <Pointer <Int8 mimeTypes , int numMimeTypes → bool
clipboard
Offer clipboard data to the OS.
sdlSetClipboardText (String ?text → bool
clipboard
Put UTF-8 text into the clipboard.
sdlSetCurrentThreadPriority (int priority → bool
thread
Set the priority for the current thread.
sdlSetCursor (Pointer <SdlCursor cursor → bool
mouse
Set the active cursor.
sdlSetDefaultTextureScaleMode (Pointer <SdlRenderer renderer , int scaleMode → bool
render
Set default scale mode for new textures for given renderer.
sdlSetEnvironmentVariable (Pointer <SdlEnvironment env , String ?name , String ?value , bool overwrite → bool
stdinc
Set the value of a variable in the environment.
sdlSetenvUnsafe (String ?name , String ?value , int overwrite → int
stdinc
Set the value of a variable in the environment.
sdlSetError (String ?fmt → bool
error
Set the SDL error message for the current thread.
sdlSetErrorV (String ?fmt → bool
error
Set the SDL error message for the current thread.
sdlSetEventEnabled (int type , bool enabled → void
events
Set the state of processing events by type.
sdlSetEventFilter (Pointer <NativeFunction <SdlEventFilter filter , Pointer <NativeType userdata → void
events
Set up a filter to process all events before they are added to the internal
event queue.
sdlSetFloatProperty (int props , String ?name , double value → bool
properties
Set a floating point property in a group of properties.
sdlSetGamepadEventsEnabled (bool enabled → void
gamepad
Set the state of gamepad event processing.
sdlSetGamepadLed (Pointer <SdlGamepad gamepad , int red , int green , int blue → bool
gamepad
Update a gamepad's LED color.
sdlSetGamepadMapping (int instanceId , String ?mapping → bool
gamepad
Set the current mapping of a joystick or gamepad.
sdlSetGamepadPlayerIndex (Pointer <SdlGamepad gamepad , int playerIndex → bool
gamepad
Set the player index of an opened gamepad.
sdlSetGamepadSensorEnabled (Pointer <SdlGamepad gamepad , int type , bool enabled → bool
gamepad
Set whether data reporting for a gamepad sensor is enabled.
sdlSetGpuAllowedFramesInFlight (Pointer <SdlGpuDevice device , int allowedFramesInFlight → bool
gpu
Configures the maximum allowed number of frames in flight.
sdlSetGpuBlendConstants (Pointer <SdlGpuRenderPass renderPass , SdlFColor blendAnts → void
gpu
Sets the current blend constants on a command buffer.
sdlSetGpuBufferName (Pointer <SdlGpuDevice device , Pointer <SdlGpuBuffer buffer , String ?text → void
gpu
Sets an arbitrary string constant to label a buffer.
sdlSetGpuRenderStateFragmentUniforms (Pointer <SdlGpuRenderState state , int slotIndex , Pointer <NativeType data , int length → bool
render
Set fragment shader uniform variables in a custom GPU render state.
sdlSetGpuScissor (Pointer <SdlGpuRenderPass renderPass , Pointer <SdlRect scissor → void
gpu
Sets the current scissor state on a command buffer.
sdlSetGpuStencilReference (Pointer <SdlGpuRenderPass renderPass , int reference → void
gpu
Sets the current stencil reference value on a command buffer.
sdlSetGpuSwapchainParameters (Pointer <SdlGpuDevice device , Pointer <SdlWindow window , int swapchainComposition , int presentMode → bool
gpu
Changes the swapchain parameters for the given claimed window.
sdlSetGpuTextureName (Pointer <SdlGpuDevice device , Pointer <SdlGpuTexture texture , String ?text → void
gpu
Sets an arbitrary string constant to label a texture.
sdlSetGpuViewport (Pointer <SdlGpuRenderPass renderPass , Pointer <SdlGpuViewport viewport → void
gpu
Sets the current viewport state on a command buffer.
sdlSetHapticAutocenter (Pointer <SdlHaptic haptic , int autocenter → bool
haptic
Set the global autocenter of the device.
sdlSetHapticGain (Pointer <SdlHaptic haptic , int gain → bool
haptic
Set the global gain of the specified haptic device.
sdlSetHint (String ?name , String ?value → bool
hints
Set a hint with normal priority.
sdlSetHintWithPriority (String ?name , String ?value , int priority → bool
hints
Set a hint with a specific priority.
sdlSetInitialized (Pointer <SdlInitState state , bool initialized → void
mutex
Finish an initialization state transition.
sdlSetiOsAnimationCallback (Pointer <SdlWindow window , int interval , Pointer <NativeFunction <SdlIOsAnimationCallback callback , Pointer <NativeType callbackParam → bool
system
Use this function to set the animation callback on Apple iOS.
sdlSetiOsEventPump (bool enabled → void
system
Use this function to enable or disable the SDL event pump on Apple iOS.
sdlSetJoystickEventsEnabled (bool enabled → void
joystick
Set the state of joystick event processing.
sdlSetJoystickLed (Pointer <SdlJoystick joystick , int red , int green , int blue → bool
joystick
Update a joystick's LED color.
sdlSetJoystickPlayerIndex (Pointer <SdlJoystick joystick , int playerIndex → bool
joystick
Set the player index of an opened joystick.
sdlSetJoystickVirtualAxis (Pointer <SdlJoystick joystick , int axis , int value → bool
joystick
Set the state of an axis on an opened virtual joystick.
sdlSetJoystickVirtualBall (Pointer <SdlJoystick joystick , int ball , int xrel , int yrel → bool
joystick
Generate ball motion on an opened virtual joystick.
sdlSetJoystickVirtualButton (Pointer <SdlJoystick joystick , int button , bool down → bool
joystick
Set the state of a button on an opened virtual joystick.
sdlSetJoystickVirtualHat (Pointer <SdlJoystick joystick , int hat , int value → bool
joystick
Set the state of a hat on an opened virtual joystick.
sdlSetJoystickVirtualTouchpad (Pointer <SdlJoystick joystick , int touchpad , int finger , bool down , double x , double y , double pressure → bool
joystick
Set touchpad finger state on an opened virtual joystick.
sdlSetLinuxThreadPriority (int threadId , int priority → bool
system
Sets the UNIX nice value for a thread.
sdlSetLinuxThreadPriorityAndPolicy (int threadId , int sdlPriority , int schedPolicy → bool
system
Sets the priority (not nice level) and scheduling policy for a thread.
sdlSetLogOutputFunction (Pointer <NativeFunction <SdlLogOutputFunction callback , Pointer <NativeType userdata → void
log
Replace the default log output function with one of your own.
sdlSetLogPriorities (int priority → void
log
Set the priority of all log categories.
sdlSetLogPriority (int category , int priority → void
log
Set the priority of a particular log category.
sdlSetLogPriorityPrefix (int priority , String ?prefix → bool
log
Set the text prepended to log messages of a given priority.
sdlSetMainReady ()
→ void
main
Circumvent failure of SDL_Init() when not using SDL_main() as an entry
point.
sdlSetMemoryFunctions (Pointer <NativeFunction <SdlMallocFunc mallocFunc , Pointer <NativeFunction <SdlCallocFunc callocFunc , Pointer <NativeFunction <SdlReallocFunc reallocFunc , Pointer <NativeFunction <SdlFreeFunc freeFunc → bool
stdinc
Replace SDL's memory allocation functions with a custom set.
sdlSetModState (int modstate → void
keyboard
Set the current key modifier state for the keyboard.
sdlSetNumberProperty (int props , String ?name , int value → bool
properties
Set an integer property in a group of properties.
sdlSetPaletteColors (Pointer <SdlPalette palette , Pointer <SdlColor colors , int firstcolor , int ncolors → bool
pixels
Set a range of colors in a palette.
sdlSetPointerProperty (int props , String ?name , Pointer <NativeType value → bool
properties
Set a pointer property in a group of properties.
sdlSetPointerPropertyWithCleanup (int props , String ?name , Pointer <NativeType value , Pointer <NativeFunction <SdlCleanupPropertyCallback cleanup , Pointer <NativeType userdata → bool
properties
Set a pointer property in a group of properties with a cleanup function
that is called when the property is deleted.
sdlSetPrimarySelectionText (String ?text → bool
clipboard
Put UTF-8 text into the primary selection.
sdlSetRelativeMouseTransform (Pointer <NativeFunction <SdlMouseMotionTransformCallback callback , Pointer <NativeType userdata → bool
mouse
Set a user-defined function by which to transform relative mouse inputs.
sdlSetRenderClipRect (Pointer <SdlRenderer renderer , Pointer <SdlRect rect → bool
render
Set the clip rectangle for rendering on the specified target.
sdlSetRenderColorScale (Pointer <SdlRenderer renderer , double scale → bool
render
Set the color scale used for render operations.
sdlSetRenderDrawBlendMode (Pointer <SdlRenderer renderer , int blendMode → bool
render
Set the blend mode used for drawing operations (Fill and Line).
sdlSetRenderDrawColor (Pointer <SdlRenderer renderer , int r , int g , int b , int a → bool
render
Set the color used for drawing operations.
sdlSetRenderDrawColorFloat (Pointer <SdlRenderer renderer , double r , double g , double b , double a → bool
render
Set the color used for drawing operations (Rect, Line and Clear).
sdlSetRenderGpuState (Pointer <SdlRenderer renderer , Pointer <SdlGpuRenderState state → bool
render
Set custom GPU render state.
sdlSetRenderLogicalPresentation (Pointer <SdlRenderer renderer , int w , int h , int mode → bool
render
Set a device-independent resolution and presentation mode for rendering.
sdlSetRenderScale (Pointer <SdlRenderer renderer , double scaleX , double scaleY → bool
render
Set the drawing scale for rendering on the current target.
sdlSetRenderTarget (Pointer <SdlRenderer renderer , Pointer <SdlTexture texture → bool
render
Set a texture as the current rendering target.
sdlSetRenderTextureAddressMode (Pointer <SdlRenderer renderer , int uMode , int vMode → bool
render
Set the texture addressing mode used in SDL_RenderGeometry().
sdlSetRenderViewport (Pointer <SdlRenderer renderer , Pointer <SdlRect rect → bool
render
Set the drawing area for rendering on the current target.
sdlSetRenderVSync (Pointer <SdlRenderer renderer , int vsync → bool
render
Toggle VSync of the given renderer.
sdlSetScancodeName (int scancode , String ?name → bool
keyboard
Set a human-readable name for a scancode.
sdlSetStringProperty (int props , String ?name , String ?value → bool
properties
Set a string property in a group of properties.
sdlSetSurfaceAlphaMod (Pointer <SdlSurface surface , int alpha → bool
surface
Set an additional alpha value used in blit operations.
sdlSetSurfaceBlendMode (Pointer <SdlSurface surface , int blendMode → bool
surface
Set the blend mode used for blit operations.
sdlSetSurfaceClipRect (Pointer <SdlSurface surface , Pointer <SdlRect rect → bool
surface
Set the clipping rectangle for a surface.
sdlSetSurfaceColorKey (Pointer <SdlSurface surface , bool enabled , int key → bool
surface
Set the color key (transparent pixel) in a surface.
sdlSetSurfaceColorMod (Pointer <SdlSurface surface , int r , int g , int b → bool
surface
Set an additional color value multiplied into blit operations.
sdlSetSurfaceColorspace (Pointer <SdlSurface surface , int colorspace → bool
surface
Set the colorspace used by a surface.
sdlSetSurfacePalette (Pointer <SdlSurface surface , Pointer <SdlPalette palette → bool
surface
Set the palette used by a surface.
sdlSetSurfaceRle (Pointer <SdlSurface surface , bool enabled → bool
surface
Set the RLE acceleration hint for a surface.
sdlSetTextInputArea (Pointer <SdlWindow window , Pointer <SdlRect rect , int cursor → bool
keyboard
Set the area used to type Unicode text input.
sdlSetTextureAlphaMod (Pointer <SdlTexture texture , int alpha → bool
render
Set an additional alpha value multiplied into render copy operations.
sdlSetTextureAlphaModFloat (Pointer <SdlTexture texture , double alpha → bool
render
Set an additional alpha value multiplied into render copy operations.
sdlSetTextureBlendMode (Pointer <SdlTexture texture , int blendMode → bool
render
Set the blend mode for a texture, used by SDL_RenderTexture().
sdlSetTextureColorMod (Pointer <SdlTexture texture , int r , int g , int b → bool
render
Set an additional color value multiplied into render copy operations.
sdlSetTextureColorModFloat (Pointer <SdlTexture texture , double r , double g , double b → bool
render
Set an additional color value multiplied into render copy operations.
sdlSetTextureScaleMode (Pointer <SdlTexture texture , int scaleMode → bool
render
Set the scale mode used for texture scale operations.
sdlSetTls (Pointer <SdlAtomicInt id , Pointer <NativeType value , Pointer <NativeType deor → bool
thread
Set the current thread's value associated with a thread local storage ID.
sdlSetTrayEntryCallback (Pointer <SdlTrayEntry entry , Pointer <NativeFunction <SdlTrayCallback callback , Pointer <NativeType userdata → void
tray
Sets a callback to be invoked when the entry is selected.
sdlSetTrayEntryChecked (Pointer <SdlTrayEntry entry , bool checked → void
tray
Sets whether or not an entry is checked.
sdlSetTrayEntryEnabled (Pointer <SdlTrayEntry entry , bool enabled → void
tray
Sets whether or not an entry is enabled.
sdlSetTrayEntryLabel (Pointer <SdlTrayEntry entry , String ?label → void
tray
Sets the label of an entry.
sdlSetTrayIcon (Pointer <SdlTray tray , Pointer <SdlSurface icon → void
tray
Updates the system tray icon's icon.
sdlSetTrayTooltip (Pointer <SdlTray tray , String ?tooltip → void
tray
Updates the system tray icon's tooltip.
sdlSetWindowAlwaysOnTop (Pointer <SdlWindow window , bool onTop → bool
video
Set the window to always be above the others.
sdlSetWindowAspectRatio (Pointer <SdlWindow window , double minAspect , double maxAspect → bool
video
Request that the aspect ratio of a window's client area be set.
sdlSetWindowBordered (Pointer <SdlWindow window , bool bordered → bool
video
Set the border state of a window.
sdlSetWindowFocusable (Pointer <SdlWindow window , bool focusable → bool
video
Set whether the window may have input focus.
sdlSetWindowFullscreen (Pointer <SdlWindow window , bool fullscreen → bool
video
Request that the window's fullscreen state be changed.
sdlSetWindowFullscreenMode (Pointer <SdlWindow window , Pointer <SdlDisplayMode mode → bool
video
Set the display mode to use when a window is visible and fullscreen.
sdlSetWindowHitTest (Pointer <SdlWindow window , Pointer <NativeFunction <SdlHitTest callback , Pointer <NativeType callbackData → bool
video
Provide a callback that decides if a window region has special properties.
sdlSetWindowIcon (Pointer <SdlWindow window , Pointer <SdlSurface icon → bool
video
Set the icon for a window.
sdlSetWindowKeyboardGrab (Pointer <SdlWindow window , bool grabbed → bool
video
Set a window's keyboard grab mode.
sdlSetWindowMaximumSize (Pointer <SdlWindow window , int maxW , int maxH → bool
video
Set the maximum size of a window's client area.
sdlSetWindowMinimumSize (Pointer <SdlWindow window , int minW , int minH → bool
video
Set the minimum size of a window's client area.
sdlSetWindowModal (Pointer <SdlWindow window , bool modal → bool
video
Toggle the state of the window as modal.
sdlSetWindowMouseGrab (Pointer <SdlWindow window , bool grabbed → bool
video
Set a window's mouse grab mode.
sdlSetWindowMouseRect (Pointer <SdlWindow window , Pointer <SdlRect rect → bool
video
Confines the cursor to the specified area of a window.
sdlSetWindowOpacity (Pointer <SdlWindow window , double opacity → bool
video
Set the opacity for a window.
sdlSetWindowParent (Pointer <SdlWindow window , Pointer <SdlWindow parent → bool
video
Set the window as a child of a parent window.
sdlSetWindowPosition (Pointer <SdlWindow window , int x , int y → bool
video
Request that the window's position be set.
sdlSetWindowProgressState (Pointer <SdlWindow window , int state → bool
video
Sets the state of the progress bar for the given window’s taskbar icon.
sdlSetWindowProgressValue (Pointer <SdlWindow window , double value → bool
video
Sets the value of the progress bar for the given window’s taskbar icon.
sdlSetWindowRelativeMouseMode (Pointer <SdlWindow window , bool enabled → bool
mouse
Set relative mouse mode for a window.
sdlSetWindowResizable (Pointer <SdlWindow window , bool resizable → bool
video
Set the user-resizable state of a window.
sdlSetWindowShape (Pointer <SdlWindow window , Pointer <SdlSurface shape → bool
video
Set the shape of a transparent window.
sdlSetWindowSize (Pointer <SdlWindow window , int w , int h → bool
video
Request that the size of a window's client area be set.
sdlSetWindowsMessageHook (Pointer <NativeFunction <SdlWindowsMessageHook callback , Pointer <NativeType userdata → void
system
Set a callback for every Windows message, run before TranslateMessage().
sdlSetWindowSurfaceVSync (Pointer <SdlWindow window , int vsync → bool
video
Toggle VSync for the window surface.
sdlSetWindowTitle (Pointer <SdlWindow window , String ?title → bool
video
Set the title of a window.
sdlSetX11EventHook (Pointer <NativeFunction <SdlX11EventHook callback , Pointer <NativeType userdata → void
system
Set a callback for every X11 event.
sdlShouldInit (Pointer <SdlInitState state → bool
mutex
Return whether initialization should be done.
sdlShouldQuit (Pointer <SdlInitState state → bool
mutex
Return whether cleanup should be done.
sdlShowAndroidToast (String ?message , int duration , int gravity , int xoffset , int yoffset → bool
system
Shows an Android toast notification.
sdlShowCursor ()
→ bool
mouse
Show the cursor.
sdlShowFileDialogWithProperties (int type , Pointer <NativeFunction <SdlDialogFileCallback callback , Pointer <NativeType userdata , int props → void
dialog
Create and launch a file dialog with the specified properties.
sdlShowMessageBox (Pointer <SdlMessageBoxData messageboxdata , Pointer <Int32 buttonid → bool
messagebox
Create a modal message box.
sdlShowOpenFileDialog (Pointer <NativeFunction <SdlDialogFileCallback callback , Pointer <NativeType userdata , Pointer <SdlWindow window , Pointer <SdlDialogFileFilter filters , int nfilters , String ?defaultLocation , bool allowMany → void
dialog
Displays a dialog that lets the user select a file on their filesystem.
sdlShowOpenFolderDialog (Pointer <NativeFunction <SdlDialogFileCallback callback , Pointer <NativeType userdata , Pointer <SdlWindow window , String ?defaultLocation , bool allowMany → void
dialog
Displays a dialog that lets the user select a folder on their filesystem.
sdlShowSaveFileDialog (Pointer <NativeFunction <SdlDialogFileCallback callback , Pointer <NativeType userdata , Pointer <SdlWindow window , Pointer <SdlDialogFileFilter filters , int nfilters , String ?defaultLocation → void
dialog
Displays a dialog that lets the user choose a new or existing file on their
filesystem.
sdlShowSimpleMessageBox (int flags , String ?title , String ?message , Pointer <SdlWindow window → bool
messagebox
Display a simple modal message box.
sdlShowWindow (Pointer <SdlWindow window → bool
video
Show a window.
Display the system-level window menu.
sdlSignalAsyncIoQueue (Pointer <SdlAsyncIoQueue queue → void
asyncio
Wake up any threads that are blocking in SDL_WaitAsyncIOResult().
sdlSignalCondition (Pointer <SdlCondition cond → void
mutex
Restart one of the threads that are waiting on the condition variable.
sdlSignalSemaphore (Pointer <SdlSemaphore sem → void
mutex
Atomically increment a semaphore's value and wake waiting threads.
sdlSin (double x → double
stdinc
Compute the sine of x.
sdlSinf (double x → double
stdinc
Compute the sine of x.
sdlSnprintf (Pointer <Int8 text , int maxlen , String ?fmt → int
stdinc
This works exactly like snprintf() but doesn't require access to a C
runtime.
sdlSqrt (double x → double
stdinc
Compute the square root of x.
sdlSqrtf (double x → double
stdinc
Compute the square root of x.
sdlSrand (int seed → void
stdinc
Seeds the pseudo-random number generator.
sdlSscanf (String ?text , String ?fmt → int
stdinc
This works exactly like sscanf() but doesn't require access to a C runtime.
sdlStartTextInput (Pointer <SdlWindow window → bool
keyboard
Start accepting Unicode text input events in a window.
sdlStartTextInputWithProperties (Pointer <SdlWindow window , int props → bool
keyboard
Start accepting Unicode text input events in a window, with properties
describing the input.
sdlStepBackUtf8 (String ?start , Pointer <Pointer <Int8 pstr → int
stdinc
Decode a UTF-8 string in reverse, one Unicode codepoint at a time.
sdlStepUtf8 (Pointer <Pointer <Int8 pstr , Pointer <Uint32 pslen → int
stdinc
Decode a UTF-8 string, one Unicode codepoint at a time.
sdlStopHapticEffect (Pointer <SdlHaptic haptic , int effect → bool
haptic
Stop the haptic effect on its associated haptic device.
sdlStopHapticEffects (Pointer <SdlHaptic haptic → bool
haptic
Stop all the currently playing effects on a haptic device.
sdlStopHapticRumble (Pointer <SdlHaptic haptic → bool
haptic
Stop the simple rumble on a haptic device.
sdlStopTextInput (Pointer <SdlWindow window → bool
keyboard
Stop receiving any text input events in a window.
sdlStorageReady (Pointer <SdlStorage storage → bool
storage
Checks if the storage container is ready to use.
sdlStrcasecmp (String ?str1 , String ?str2 → int
stdinc
Compare two null-terminated UTF-8 strings, case-insensitively.
sdlStrcasestr (String ?haystack , String ?needle → Pointer <Int8
stdinc
Search a UTF-8 string for the first instance of a specific substring,
case-insensitively.
sdlStrchr (String ?str , int c → Pointer <Int8
stdinc
Search a string for the first instance of a specific byte.
sdlStrcmp (String ?str1 , String ?str2 → int
stdinc
Compare two null-terminated UTF-8 strings.
sdlStrdup (String ?str → Pointer <Int8
stdinc
Allocate a copy of a string.
sdlStretchSurface (Pointer <SdlSurface src , Pointer <SdlRect srcrect , Pointer <SdlSurface dst , Pointer <SdlRect dstrect , int scaleMode → bool
surface
Perform a stretched pixel copy from one surface to another.
sdlStringToGuid (String ?pchGuid → SdlGuid
guid
Convert a GUID string into a SDL_GUID structure.
sdlStrlcat (Pointer <NativeType arg0 , String ?src , int maxlen → int
stdinc
Concatenate strings.
sdlStrlcpy (Pointer <Int8 dst , String ?src , int maxlen → int
stdinc
Copy a string.
sdlStrlen (String ?str → int
stdinc
This works exactly like strlen() but doesn't require access to a C runtime.
sdlStrlwr (Pointer <Int8 str → Pointer <Int8
stdinc
Convert a string to lowercase.
sdlStrncasecmp (String ?str1 , String ?str2 , int maxlen → int
stdinc
Compare two UTF-8 strings, case-insensitively, up to a number of bytes.
sdlStrncmp (String ?str1 , String ?str2 , int maxlen → int
stdinc
Compare two UTF-8 strings up to a number of bytes.
sdlStrndup (String ?str , int maxlen → Pointer <Int8
stdinc
Allocate a copy of a string, up to n characters.
sdlStrnlen (String ?str , int maxlen → int
stdinc
This works exactly like strnlen() but doesn't require access to a C
runtime.
sdlStrnstr (String ?haystack , String ?needle , int maxlen → Pointer <Int8
stdinc
Search a string, up to n bytes, for the first instance of a specific
substring.
sdlStrpbrk (String ?str , String ?breakset → Pointer <Int8
stdinc
Searches a string for the first occurrence of any character contained in a
breakset, and returns a pointer from the string to that character.
sdlStrrchr (String ?str , int c → Pointer <Int8
stdinc
Search a string for the last instance of a specific byte.
sdlStrrev (Pointer <Int8 str → Pointer <Int8
stdinc
Reverse a string's contents.
sdlStrstr (String ?haystack , String ?needle → Pointer <Int8
stdinc
Search a string for the first instance of a specific substring.
sdlStrtod (String ?str , Pointer <Pointer <Int8 endp → double
stdinc
Parse a double from a string.
sdlStrtokR (Pointer <Int8 str , String ?delim , Pointer <Pointer <Int8 saveptr → Pointer <Int8
stdinc
This works exactly like strtok_r() but doesn't require access to a C
runtime.
sdlStrtol (String ?str , Pointer <Pointer <Int8 endp , int base → int
stdinc
Parse a long from a string.
sdlStrtoll (String ?str , Pointer <Pointer <Int8 endp , int base → Pointer <NativeType
stdinc
Parse a long long from a string.
sdlStrtoul (String ?str , Pointer <Pointer <Int8 endp , int base → int
stdinc
Parse an unsigned long from a string.
sdlStrtoull (String ?str , Pointer <Pointer <Int8 endp , int base → Pointer <NativeType
stdinc
Parse an unsigned long long from a string.
sdlStrupr (Pointer <Int8 str → Pointer <Int8
stdinc
Convert a string to uppercase.
sdlSubmitGpuCommandBuffer (Pointer <SdlGpuCommandBuffer commandBuffer → bool
gpu
Submits a command buffer so its commands can be processed on the GPU.
sdlSubmitGpuCommandBufferAndAcquireFence (Pointer <SdlGpuCommandBuffer commandBuffer → Pointer <SdlGpuFence
gpu
Submits a command buffer so its commands can be processed on the GPU, and
acquires a fence associated with the command buffer.
sdlSurfaceHasAlternateImages (Pointer <SdlSurface surface → bool
surface
Return whether a surface has alternate versions available.
sdlSurfaceHasColorKey (Pointer <SdlSurface surface → bool
surface
Returns whether the surface has a color key.
sdlSurfaceHasRle (Pointer <SdlSurface surface → bool
surface
Returns whether the surface is RLE enabled.
sdlSwprintf (Pointer <Int16 text , int maxlen , Pointer <Int16 fmt → int
stdinc
This works exactly like swprintf() but doesn't require access to a C
runtime.
sdlSyncWindow (Pointer <SdlWindow window → bool
video
Block until any pending window state is finalized.
sdlTan (double x → double
stdinc
Compute the tangent of x.
sdlTanf (double x → double
stdinc
Compute the tangent of x.
sdlTellIo (Pointer <SdlIoStream context → int
iostream
Determine the current read/write offset in an SDL_IOStream data stream.
sdlTextInputActive (Pointer <SdlWindow window → bool
keyboard
Check whether or not Unicode text input events are enabled for a window.
sdlTimeFromWindows (int dwLowDateTime , int dwHighDateTime → int
time
Converts a Windows FILETIME (100-nanosecond intervals since January 1,
1601) to an SDL time.
sdlTimeToDateTime (int ticks , Pointer <SdlDateTime dt , bool localTime → bool
time
Converts an SDL_Time in nanoseconds since the epoch to a calendar time in
the SDL_DateTime format.
sdlTimeToWindows (int ticks , Pointer <Uint32 dwLowDateTime , Pointer <Uint32 dwHighDateTime → void
time
Converts an SDL time into a Windows FILETIME (100-nanosecond intervals
since January 1, 1601).
sdlTolower (int x → int
stdinc
Convert low-ASCII English letters to lowercase.
sdlToupper (int x → int
stdinc
Convert low-ASCII English letters to uppercase.
sdlTrunc (double x → double
stdinc
Truncate x to an integer.
sdlTruncf (double x → double
stdinc
Truncate x to an integer.
sdlTryLockMutex (Pointer <NativeType arg0 , Pointer <NativeType arg1 → bool
mutex
Try to lock a mutex without blocking.
sdlTryLockRwLockForReading (Pointer <NativeType arg0 , Pointer <NativeType arg1 → bool
mutex
Try to lock a read/write lock for reading without blocking.
sdlTryLockRwLockForWriting (Pointer <NativeType arg0 , Pointer <NativeType arg1 → bool
mutex
Try to lock a read/write lock for writing without blocking.
sdlTryLockSpinlock (Pointer <Int32 lock → bool
atomic
Try to lock a spin lock by setting it to a non-zero value.
sdlTryWaitSemaphore (Pointer <SdlSemaphore sem → bool
mutex
See if a semaphore has a positive value and decrement it if it does.
sdlUcs4ToUtf8 (int codepoint , Pointer <Int8 dst → Pointer <Int8
stdinc
Convert a single Unicode codepoint to UTF-8.
sdlUitoa (int value , Pointer <Int8 str , int radix → Pointer <Int8
stdinc
Convert an unsigned integer into a string.
sdlUlltoa (Pointer <NativeType value , Pointer <Int8 str , int radix → Pointer <Int8
stdinc
Convert an unsigned long long integer into a string.
sdlUltoa (int value , Pointer <Int8 str , int radix → Pointer <Int8
stdinc
Convert an unsigned long integer into a string.
sdlUnbindAudioStream (Pointer <SdlAudioStream stream → void
audio
Unbind a single audio stream from its audio device.
sdlUnbindAudioStreams (Pointer <Pointer <SdlAudioStream streams , int numStreams → void
audio
Unbind a list of audio streams from their audio devices.
sdlUnloadObject (Pointer <SdlSharedObject handle → void
loadso
Unload a shared object from memory.
sdlUnlockAudioStream (Pointer <SdlAudioStream stream → bool
audio
Unlock an audio stream for serialized access.
sdlUnlockJoysticks (Pointer <NativeType arg0 → void
joystick
Unlocking for atomic access to the joystick API.
sdlUnlockMutex (Pointer <NativeType arg0 → void
mutex
Unlock the mutex.
sdlUnlockProperties (int props → void
properties
Unlock a group of properties.
sdlUnlockRwLock (Pointer <NativeType arg0 → void
mutex
Unlock the read/write lock.
sdlUnlockSpinlock (Pointer <Int32 lock → void
atomic
Unlock a spin lock by setting it to 0.
sdlUnlockSurface (Pointer <SdlSurface surface → void
surface
Release a surface after directly accessing the pixels.
sdlUnlockTexture (Pointer <SdlTexture texture → void
render
Unlock a texture, uploading the changes to video memory, if needed.
sdlUnmapGpuTransferBuffer (Pointer <SdlGpuDevice device , Pointer <SdlGpuTransferBuffer transferBuffer → void
gpu
Unmaps a previously mapped transfer buffer.
sdlUnregisterApp ()
→ void
main
Deregister the win32 window class from an SDL_RegisterApp call.
sdlUnsetEnvironmentVariable (Pointer <SdlEnvironment env , String ?name → bool
stdinc
Clear a variable from the environment.
sdlUnsetenvUnsafe (String ?name → int
stdinc
Clear a variable from the environment.
sdlUpdateGamepads ()
→ void
gamepad
Manually pump gamepad updates if not using the loop.
sdlUpdateHapticEffect (Pointer <SdlHaptic haptic , int effect , Pointer <SdlHapticEffect data → bool
haptic
Update the properties of an effect.
sdlUpdateJoysticks ()
→ void
joystick
Update the current state of the open joysticks.
sdlUpdateNvTexture (Pointer <SdlTexture texture , Pointer <SdlRect rect , Pointer <Uint8 yplane , int ypitch , Pointer <Uint8 uVplane , int uVpitch → bool
render
Update a rectangle within a planar NV12 or NV21 texture with new pixels.
sdlUpdateSensors ()
→ void
sensor
Update the current state of the open sensors.
sdlUpdateTexture (Pointer <SdlTexture texture , Pointer <SdlRect rect , Pointer <NativeType pixels , int pitch → bool
render
Update the given texture rectangle with new pixel data.
sdlUpdateTrays ()
→ void
tray
Update the trays.
sdlUpdateWindowSurface (Pointer <SdlWindow window → bool
video
Copy the window surface to the screen.
sdlUpdateWindowSurfaceRects (Pointer <SdlWindow window , Pointer <SdlRect rects , int numrects → bool
video
Copy areas of the window surface to the screen.
sdlUpdateYuvTexture (Pointer <SdlTexture texture , Pointer <SdlRect rect , Pointer <Uint8 yplane , int ypitch , Pointer <Uint8 uplane , int upitch , Pointer <Uint8 vplane , int vpitch → bool
render
Update a rectangle within a planar YV12 or IYUV texture with new pixel
data.
sdlUploadToGpuBuffer (Pointer <SdlGpuCopyPass copyPass , Pointer <SdlGpuTransferBufferLocation source , Pointer <SdlGpuBufferRegion destination , bool cycle → void
gpu
Uploads data from a transfer buffer to a buffer.
sdlUploadToGpuTexture (Pointer <SdlGpuCopyPass copyPass , Pointer <SdlGpuTextureTransferInfo source , Pointer <SdlGpuTextureRegion destination , bool cycle → void
gpu
Uploads data from a transfer buffer to a texture.
sdlUtf8strlcpy (Pointer <Int8 dst , String ?src , int dstBytes → int
stdinc
Copy an UTF-8 string.
sdlUtf8strlen (String ?str → int
stdinc
Count the number of codepoints in a UTF-8 string.
sdlUtf8strnlen (String ?str , int bytes → int
stdinc
Count the number of codepoints in a UTF-8 string, up to n bytes.
sdlVasprintf (Pointer <Pointer <Int8 strp , String ?fmt → int
stdinc
This works exactly like vasprintf() but doesn't require access to a C
runtime.
sdlVersionAtleast (int x , int y , int z → bool
const SDL_VERSION_ATLEAST = (X, Y, Z) \ (SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z));
sdlVersionnum (int x , int y , int z → int
const SDL_VERSION = (x) \{ \ (x)->major = SDL_MAJOR_VERSION; \ (x)->minor = SDL_MINOR_VERSION; \ (x)->patch = SDL_PATCHLEVEL; \};
sdlVsnprintf (Pointer <Int8 text , int maxlen , String ?fmt → int
stdinc
This works exactly like vsnprintf() but doesn't require access to a C
runtime.
sdlVsscanf (String ?text , String ?fmt → int
stdinc
This works exactly like vsscanf() but doesn't require access to a C
runtime.
sdlVswprintf (Pointer <Int16 text , int maxlen , Pointer <Int16 fmt → int
stdinc
This works exactly like vswprintf() but doesn't require access to a C
runtime.
sdlVulkanCreateSurface (Pointer <SdlWindow window , Pointer <NativeType instance , Pointer <Pointer <NativeType allocator , Pointer <Pointer <NativeType surface → bool
vulkan
Create a Vulkan rendering surface for a window.
sdlVulkanDestroySurface (Pointer <NativeType instance , Pointer <NativeType surface , Pointer <Pointer <NativeType allocator → void
vulkan
Destroy the Vulkan rendering surface of a window.
sdlVulkanGetInstanceExtensions (Pointer <Uint32 count → Pointer <Pointer <Int8
vulkan
Get the Vulkan instance extensions needed for vkCreateInstance.
sdlVulkanGetPresentationSupport (Pointer <NativeType instance , Pointer <NativeType physicalDevice , int queueFamilyIndex → bool
vulkan
Query support for presentation via a given physical device and queue
family.
sdlVulkanGetVkGetInstanceProcAddr ()
→ Pointer <NativeType
vulkan
Get the address of the vkGetInstanceProcAddr function.
sdlVulkanLoadLibrary (String ?path → bool
vulkan
Dynamically load the Vulkan loader library.
sdlVulkanUnloadLibrary ()
→ void
vulkan
Unload the Vulkan library previously loaded by SDL_Vulkan_LoadLibrary().
sdlWaitAndAcquireGpuSwapchainTexture (Pointer <SdlGpuCommandBuffer commandBuffer , Pointer <SdlWindow window , Pointer <Pointer <SdlGpuTexture swapchainTexture , Pointer <Uint32 swapchainTextureWidth , Pointer <Uint32 swapchainTextureHeight → bool
gpu
Blocks the thread until a swapchain texture is available to be acquired,
and then acquires it.
sdlWaitAsyncIoResult (Pointer <SdlAsyncIoQueue queue , Pointer <SdlAsyncIoOutcome outcome , int timeoutMs → bool
asyncio
Block until an async I/O task queue has a completed task.
sdlWaitCondition (Pointer <SdlCondition cond , Pointer <SdlMutex mutex → void
mutex
Wait until a condition variable is signaled.
sdlWaitConditionTimeout (Pointer <SdlCondition cond , Pointer <SdlMutex mutex , int timeoutMs → bool
mutex
Wait until a condition variable is signaled or a certain time has passed.
sdlWaitEvent (Pointer <SdlEvent event → bool
events
Wait indefinitely for the next available event.
sdlWaitEventTimeout (Pointer <SdlEvent event , int timeoutMs → bool
events
Wait until the specified timeout (in milliseconds) for the next available
event.
sdlWaitForGpuFences (Pointer <SdlGpuDevice device , bool waitAll , Pointer <Pointer <SdlGpuFence fences , int numFences → bool
gpu
Blocks the thread until the given fences are signaled.
sdlWaitForGpuIdle (Pointer <SdlGpuDevice device → bool
gpu
Blocks the thread until the GPU is completely idle.
sdlWaitForGpuSwapchain (Pointer <SdlGpuDevice device , Pointer <SdlWindow window → bool
gpu
Blocks the thread until a swapchain texture is available to be acquired.
sdlWaitProcess (Pointer <SdlProcess process , bool block , Pointer <Int32 exitcode → bool
process
Wait for a process to finish.
sdlWaitSemaphore (Pointer <SdlSemaphore sem → void
mutex
Wait until a semaphore has a positive value and then decrements it.
sdlWaitSemaphoreTimeout (Pointer <SdlSemaphore sem , int timeoutMs → bool
mutex
Wait until a semaphore has a positive value and then decrements it.
sdlWaitThread (Pointer <SdlThread thread , Pointer <Int32 status → void
thread
Wait for a thread to finish.
sdlWarpMouseGlobal (double x , double y → bool
mouse
Move the mouse to the given position in global screen space.
sdlWarpMouseInWindow (Pointer <SdlWindow window , double x , double y → void
mouse
Move the mouse cursor to the given position within the window.
sdlWasInit (int flags → int
init
Get a mask of the specified subsystems which are currently initialized.
sdlWcscasecmp (Pointer <Int16 str1 , Pointer <Int16 str2 → int
stdinc
Compare two null-terminated wide strings, case-insensitively.
sdlWcscmp (Pointer <Int16 str1 , Pointer <Int16 str2 → int
stdinc
Compare two null-terminated wide strings.
sdlWcsdup (Pointer <Int16 wstr → Pointer <Int16
stdinc
Allocate a copy of a wide string.
sdlWcslcat (Pointer <NativeType arg0 , Pointer <Int16 src , int maxlen → int
stdinc
Concatenate wide strings.
sdlWcslcpy (Pointer <Int16 dst , Pointer <Int16 src , int maxlen → int
stdinc
Copy a wide string.
sdlWcslen (Pointer <Int16 wstr → int
stdinc
This works exactly like wcslen() but doesn't require access to a C runtime.
sdlWcsncasecmp (Pointer <Int16 str1 , Pointer <Int16 str2 , int maxlen → int
stdinc
Compare two wide strings, case-insensitively, up to a number of wchar_t.
sdlWcsncmp (Pointer <Int16 str1 , Pointer <Int16 str2 , int maxlen → int
stdinc
Compare two wide strings up to a number of wchar_t values.
sdlWcsnlen (Pointer <Int16 wstr , int maxlen → int
stdinc
This works exactly like wcsnlen() but doesn't require access to a C
runtime.
sdlWcsnstr (Pointer <Int16 haystack , Pointer <Int16 needle , int maxlen → Pointer <Int16
stdinc
Search a wide string, up to n wide chars, for the first instance of a
specific substring.
sdlWcsstr (Pointer <Int16 haystack , Pointer <Int16 needle → Pointer <Int16
stdinc
Search a wide string for the first instance of a specific substring.
sdlWcstol (Pointer <Int16 str , Pointer <Pointer <Int16 endp , int base → int
stdinc
Parse a long from a wide string.
sdlWindowHasSurface (Pointer <SdlWindow window → bool
video
Return whether the window has a surface associated with it.
sdlWindowposCenteredDisplay (int x → int
const SDL_WINDOWPOS_CENTERED_DISPLAY = (X) (SDL_WINDOWPOS_CENTERED_MASK|(X));
sdlWindowposIscentered (int x → bool
const SDL_WINDOWPOS_ISCENTERED = (X) \ (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK);
sdlWindowposIsundefined (int x → bool
const SDL_WINDOWPOS_ISUNDEFINED = (X) \ (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK);
sdlWindowposUndefinedDisplay (int x → int
SDL_WINDOWPOS_UNDEFINED_DISPLAY = (X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X));
sdlWindowSupportsGpuPresentMode (Pointer <SdlGpuDevice device , Pointer <SdlWindow window , int presentMode → bool
gpu
Determines whether a presentation mode is supported by the window.
sdlWindowSupportsGpuSwapchainComposition (Pointer <SdlGpuDevice device , Pointer <SdlWindow window , int swapchainComposition → bool
gpu
Determines whether a swapchain composition is supported by the window.
sdlWriteAsyncIo (Pointer <SdlAsyncIo asyncio , Pointer <NativeType ptr , int offset , int size , Pointer <SdlAsyncIoQueue queue , Pointer <NativeType userdata → bool
asyncio
Start an async write.
sdlWriteIo (Pointer <SdlIoStream context , Pointer <NativeType ptr , int size → int
iostream
Write to an SDL_IOStream data stream.
sdlWriteS16Be (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 16 bits in native format to an SDL_IOStream as
big-endian data.
sdlWriteS16Le (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 16 bits in native format to an SDL_IOStream as
little-endian data.
sdlWriteS32Be (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 32 bits in native format to an SDL_IOStream as
big-endian data.
sdlWriteS32Le (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 32 bits in native format to an SDL_IOStream as
little-endian data.
sdlWriteS64Be (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 64 bits in native format to an SDL_IOStream as
big-endian data.
sdlWriteS64Le (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 64 bits in native format to an SDL_IOStream as
little-endian data.
sdlWriteS8 (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write a signed byte to an SDL_IOStream.
sdlWriteStorageFile (Pointer <SdlStorage storage , String ?path , Pointer <NativeType source , int length → bool
storage
Synchronously write a file from client memory into a storage container.
sdlWriteSurfacePixel (Pointer <SdlSurface surface , int x , int y , int r , int g , int b , int a → bool
surface
Writes a single pixel to a surface.
sdlWriteSurfacePixelFloat (Pointer <SdlSurface surface , int x , int y , double r , double g , double b , double a → bool
surface
Writes a single pixel to a surface.
sdlWriteU16Be (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 16 bits in native format to an SDL_IOStream as
big-endian data.
sdlWriteU16Le (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 16 bits in native format to an SDL_IOStream as
little-endian data.
sdlWriteU32Be (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 32 bits in native format to an SDL_IOStream as
big-endian data.
sdlWriteU32Le (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 32 bits in native format to an SDL_IOStream as
little-endian data.
sdlWriteU64Be (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 64 bits in native format to an SDL_IOStream as
big-endian data.
sdlWriteU64Le (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write 64 bits in native format to an SDL_IOStream as
little-endian data.
sdlWriteU8 (Pointer <SdlIoStream dst , int value → bool
iostream
Use this function to write a byte to an SDL_IOStream.
Typedefs
SdlAppEventFunc
= Int32 Function(Pointer <NativeType appstate , Pointer <SdlEvent event
SdlAppEventFuncDart
= int Function(Pointer <NativeType appstate , Pointer <SdlEvent event
SdlAppInitFunc
= Int32 Function(Pointer <Pointer <NativeType appstate , Int32 argc , Pointer <Pointer <Int8 argv
SdlAppInitFuncDart
= int Function(Pointer <Pointer <NativeType appstate , int argc , Pointer <Pointer <Int8 argv
SdlAppIterateFunc
= Int32 Function(Pointer <NativeType appstate
SdlAppIterateFuncDart
= int Function(Pointer <NativeType appstate
SdlAppQuitFunc
= Void Function(Pointer <NativeType appstate , Int32 result
SdlAppQuitFuncDart
= void Function(Pointer <NativeType appstate , int result
SdlAssertionHandler
= Int32 Function(Pointer <SdlAssertData data , Pointer <NativeType userdata
SdlAssertionHandlerDart
= int Function(Pointer <SdlAssertData data , Pointer <NativeType userdata
SdlAudioPostmixCallback
= Void Function(Pointer <NativeType userdata , Pointer <SdlAudioSpec spec , Pointer <Float buffer , Int32 buflen
SdlAudioPostmixCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <SdlAudioSpec spec , Pointer <Float buffer , int buflen
SdlAudioStreamCallback
= Void Function(Pointer <NativeType userdata , Pointer <SdlAudioStream stream , Int32 additionalAmount , Int32 totalAmount
SdlAudioStreamCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <SdlAudioStream stream , int additionalAmount , int totalAmount
SdlAudioStreamDataCompleteCallback
= Void Function(Pointer <NativeType userdata , Pointer <NativeType buf , Int32 buflen
SdlAudioStreamDataCompleteCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <NativeType buf , int buflen
SdlCallocFunc
= Pointer <NativeType Function(Uint32 nmemb , Uint32 size
SdlCallocFuncDart
= Pointer <NativeType Function(int nmemb , int size
SdlCleanupPropertyCallback
= Void Function(Pointer <NativeType userdata , Pointer <NativeType value
SdlCleanupPropertyCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <NativeType value
SdlClipboardCleanupCallback
= Void Function(Pointer <NativeType userdata
SdlClipboardCleanupCallbackDart
= void Function(Pointer <NativeType userdata
SdlClipboardDataCallback
= Pointer <NativeType Function(Pointer <NativeType userdata , Pointer <Utf8 > mimeType , Pointer <Uint32 size
SdlClipboardDataCallbackDart
= Pointer <NativeType Function(Pointer <NativeType userdata , Pointer <Utf8 > mimeType , Pointer <Uint32 size
SdlCompareCallback
= Int32 Function(Pointer <NativeType a , Pointer <NativeType b
SdlCompareCallbackDart
= int Function(Pointer <NativeType a , Pointer <NativeType b
SdlCompareCallbackR
= Int32 Function(Pointer <NativeType userdata , Pointer <NativeType a , Pointer <NativeType b
SdlCompareCallbackRDart
= int Function(Pointer <NativeType userdata , Pointer <NativeType a , Pointer <NativeType b
SdlDialogFileCallback
= Void Function(Pointer <NativeType userdata , Pointer <Pointer <Int8 filelist , Int32 filter
SdlDialogFileCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <Pointer <Int8 filelist , int filter
SdlEglAttribArrayCallback
= Pointer <Uint64 Function(Pointer <NativeType userdata
SdlEglAttribArrayCallbackDart
= Pointer <Uint64 Function(Pointer <NativeType userdata
SdlEglIntArrayCallback
= Pointer <Int32 Function(Pointer <NativeType userdata , Pointer <NativeType display , Pointer <NativeType config
SdlEglIntArrayCallbackDart
= Pointer <Int32 Function(Pointer <NativeType userdata , Pointer <NativeType display , Pointer <NativeType config
SdlEnumerateDirectoryCallback
= Int32 Function(Pointer <NativeType userdata , Pointer <Utf8 > dirname , Pointer <Utf8 > fname
SdlEnumerateDirectoryCallbackDart
= int Function(Pointer <NativeType userdata , Pointer <Utf8 > dirname , Pointer <Utf8 > fname
SdlEnumeratePropertiesCallback
= Void Function(Pointer <NativeType userdata , Uint32 props , Pointer <Utf8 > name
SdlEnumeratePropertiesCallbackDart
= void Function(Pointer <NativeType userdata , int props , Pointer <Utf8 > name
SdlEventFilter
= Uint8 Function(Pointer <NativeType userdata , Pointer <SdlEvent event
SdlEventFilterDart
= int Function(Pointer <NativeType userdata , Pointer <SdlEvent event
SdlFreeFunc
= Void Function(Pointer <NativeType mem
SdlFreeFuncDart
= void Function(Pointer <NativeType mem
SdlFunctionPointer
= Void Function()
SdlFunctionPointerDart
= void Function()
SDLglproc Pointer <NativeFunction <Void Function()
SDLglprocDart
= void Function()
SdlHintCallback
= Void Function(Pointer <NativeType userdata , Pointer <Utf8 > name , Pointer <Utf8 > oldValue , Pointer <Utf8 > newValue
SdlHintCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <Utf8 > name , Pointer <Utf8 > oldValue , Pointer <Utf8 > newValue
SdlHitTest
= Int32 Function(Pointer <SdlWindow win , Pointer <SdlPoint area , Pointer <NativeType data
SdlHitTestDart
= int Function(Pointer <SdlWindow win , Pointer <SdlPoint area , Pointer <NativeType data
SdlIOsAnimationCallback
= Void Function(Pointer <NativeType userdata
SdlIOsAnimationCallbackDart
= void Function(Pointer <NativeType userdata
SdlKernelMemoryBarrierFunc
= Void Function()
SdlKernelMemoryBarrierFuncDart
= void Function()
SdlLogOutputFunction
= Void Function(Pointer <NativeType userdata , Int32 category , Int32 priority , Pointer <Utf8 > message
SdlLogOutputFunctionDart
= void Function(Pointer <NativeType userdata , int category , int priority , Pointer <Utf8 > message
SdlMainFunc
= Int32 Function(Int32 argc , Pointer <Pointer <Int8 argv
SdlMainFuncDart
= int Function(int argc , Pointer <Pointer <Int8 argv
SdlMainThreadCallback
= Void Function(Pointer <NativeType userdata
SdlMainThreadCallbackDart
= void Function(Pointer <NativeType userdata
SdlMallocFunc
= Pointer <NativeType Function(Uint32 size
SdlMallocFuncDart
= Pointer <NativeType Function(int size
SdlMouseMotionTransformCallback
= Void Function(Pointer <NativeType userdata , Uint64 timestamp , Pointer <SdlWindow window , Uint32 mouseId , Pointer <Float x , Pointer <Float y
SdlMouseMotionTransformCallbackDart
= void Function(Pointer <NativeType userdata , int timestamp , Pointer <SdlWindow window , int mouseId , Pointer <Float x , Pointer <Float y
SdlNsTimerCallback
= Uint64 Function(Pointer <NativeType userdata , Uint32 timerId , Uint64 interval
SdlNsTimerCallbackDart
= int Function(Pointer <NativeType userdata , int timerId , int interval
SdlReallocFunc
= Pointer <NativeType Function(Pointer <NativeType mem , Uint32 size
SdlReallocFuncDart
= Pointer <NativeType Function(Pointer <NativeType mem , int size
SdlRequestAndroidPermissionCallback
= Void Function(Pointer <NativeType userdata , Pointer <Utf8 > permission , Uint8 granted
SdlRequestAndroidPermissionCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <Utf8 > permission , int granted
SdlThreadFunction
= Int32 Function(Pointer <NativeType data
SdlThreadFunctionDart
= int Function(Pointer <NativeType data
SdlTimerCallback
= Uint32 Function(Pointer <NativeType userdata , Uint32 timerId , Uint32 interval
SdlTimerCallbackDart
= int Function(Pointer <NativeType userdata , int timerId , int interval
SdlTlsDestructorCallback
= Void Function(Pointer <NativeType value
SdlTlsDestructorCallbackDart
= void Function(Pointer <NativeType value
SdlTrayCallback
= Void Function(Pointer <NativeType userdata , Pointer <SdlTrayEntry entry
SdlTrayCallbackDart
= void Function(Pointer <NativeType userdata , Pointer <SdlTrayEntry entry
SdlWindowsMessageHook
= Uint8 Function(Pointer <NativeType userdata , Pointer <MSG msg
SdlWindowsMessageHookDart
= int Function(Pointer <NativeType userdata , Pointer <MSG msg
SdlX11EventHook
= Uint8 Function(Pointer <NativeType userdata , Pointer <XEvent xevent
SdlX11EventHookDart
= int Function(Pointer <NativeType userdata , Pointer <XEvent xevent
