Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Render

Description

Header file for SDL 2D rendering functions.

This API supports the following features:

single pixel points
single pixel lines
filled rectangles
texture images
2D polygons

The primitives may be drawn in opaque, blended, or additive modes.

The texture images may be drawn in opaque, blended, or additive modes. They can have an additional color tint or alpha modulation applied to them, and may also be stretched with linear interpolation.

This API is designed to accelerate simple 2D operations. You may want more functionality such as 3D polygons and particle effects, and in that case you should use SDL's OpenGL/Direct3D support, the SDL3 GPU API, or one of the many good 3D engines.

These functions must be called from the main thread. See this bug for details: https://github.com/libsdl-org/SDL/issues/986 The name of the software renderer.

Since: 3.2.0

Synopsis

sDL_SOFTWARE_RENDERER :: ByteString
sDL_GPU_RENDERER :: ByteString
data SDL_Vertex = SDL_Vertex {
- position :: SDL_FPoint
- color :: SDL_FColor
- tex_coord :: SDL_FPoint
}
newtype SDL_TextureAccess = SDL_TextureAccess {
- unwrap :: CUInt
}
pattern SDL_TEXTUREACCESS_STATIC :: SDL_TextureAccess
pattern SDL_TEXTUREACCESS_STREAMING :: SDL_TextureAccess
pattern SDL_TEXTUREACCESS_TARGET :: SDL_TextureAccess
newtype SDL_TextureAddressMode = SDL_TextureAddressMode {
- unwrap :: CInt
}
pattern SDL_TEXTURE_ADDRESS_INVALID :: SDL_TextureAddressMode
pattern SDL_TEXTURE_ADDRESS_AUTO :: SDL_TextureAddressMode
pattern SDL_TEXTURE_ADDRESS_CLAMP :: SDL_TextureAddressMode
pattern SDL_TEXTURE_ADDRESS_WRAP :: SDL_TextureAddressMode
newtype SDL_RendererLogicalPresentation = SDL_RendererLogicalPresentation {
- unwrap :: CUInt
}
pattern SDL_LOGICAL_PRESENTATION_DISABLED :: SDL_RendererLogicalPresentation
pattern SDL_LOGICAL_PRESENTATION_STRETCH :: SDL_RendererLogicalPresentation
pattern SDL_LOGICAL_PRESENTATION_LETTERBOX :: SDL_RendererLogicalPresentation
pattern SDL_LOGICAL_PRESENTATION_OVERSCAN :: SDL_RendererLogicalPresentation
pattern SDL_LOGICAL_PRESENTATION_INTEGER_SCALE :: SDL_RendererLogicalPresentation
data SDL_Renderer
data SDL_Texture = SDL_Texture {
- format :: SDL_PixelFormat
- w :: CInt
- h :: CInt
- refcount :: CInt
}
sDL_PROP_RENDERER_CREATE_NAME_STRING :: ByteString
sDL_PROP_RENDERER_CREATE_WINDOW_POINTER :: ByteString
sDL_PROP_RENDERER_CREATE_SURFACE_POINTER :: ByteString
sDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER :: ByteString
sDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER :: ByteString
sDL_PROP_RENDERER_CREATE_GPU_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN :: ByteString
sDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN :: ByteString
sDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN :: ByteString
sDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER :: ByteString
sDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER :: ByteString
sDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER :: ByteString
sDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER :: ByteString
sDL_PROP_RENDERER_NAME_STRING :: ByteString
sDL_PROP_RENDERER_WINDOW_POINTER :: ByteString
sDL_PROP_RENDERER_SURFACE_POINTER :: ByteString
sDL_PROP_RENDERER_VSYNC_NUMBER :: ByteString
sDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER :: ByteString
sDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER :: ByteString
sDL_PROP_RENDERER_TEXTURE_WRAPPING_BOOLEAN :: ByteString
sDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER :: ByteString
sDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN :: ByteString
sDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT :: ByteString
sDL_PROP_RENDERER_HDR_HEADROOM_FLOAT :: ByteString
sDL_PROP_RENDERER_D3D9_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_D3D11_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_D3D11_SWAPCHAIN_POINTER :: ByteString
sDL_PROP_RENDERER_D3D12_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_D3D12_SWAPCHAIN_POINTER :: ByteString
sDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER :: ByteString
sDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER :: ByteString
sDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER :: ByteString
sDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_VULKAN_DEVICE_POINTER :: ByteString
sDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER :: ByteString
sDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER :: ByteString
sDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER :: ByteString
sDL_PROP_RENDERER_GPU_DEVICE_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_COLORSPACE_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_FORMAT_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_ACCESS_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_WIDTH_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_HEIGHT_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_PALETTE_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT :: ByteString
sDL_PROP_TEXTURE_CREATE_HDR_HEADROOM_FLOAT :: ByteString
sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_METAL_PIXELBUFFER_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_VULKAN_TEXTURE_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_VULKAN_LAYOUT_NUMBER :: ByteString
sDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_UV_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_U_POINTER :: ByteString
sDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_V_POINTER :: ByteString
sDL_PROP_TEXTURE_COLORSPACE_NUMBER :: ByteString
sDL_PROP_TEXTURE_FORMAT_NUMBER :: ByteString
sDL_PROP_TEXTURE_ACCESS_NUMBER :: ByteString
sDL_PROP_TEXTURE_WIDTH_NUMBER :: ByteString
sDL_PROP_TEXTURE_HEIGHT_NUMBER :: ByteString
sDL_PROP_TEXTURE_SDR_WHITE_POINT_FLOAT :: ByteString
sDL_PROP_TEXTURE_HDR_HEADROOM_FLOAT :: ByteString
sDL_PROP_TEXTURE_D3D11_TEXTURE_POINTER :: ByteString
sDL_PROP_TEXTURE_D3D11_TEXTURE_U_POINTER :: ByteString
sDL_PROP_TEXTURE_D3D11_TEXTURE_V_POINTER :: ByteString
sDL_PROP_TEXTURE_D3D12_TEXTURE_POINTER :: ByteString
sDL_PROP_TEXTURE_D3D12_TEXTURE_U_POINTER :: ByteString
sDL_PROP_TEXTURE_D3D12_TEXTURE_V_POINTER :: ByteString
sDL_PROP_TEXTURE_OPENGL_TEXTURE_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGL_TEXTURE_UV_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGL_TEXTURE_U_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGL_TEXTURE_V_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGL_TEX_W_FLOAT :: ByteString
sDL_PROP_TEXTURE_OPENGL_TEX_H_FLOAT :: ByteString
sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER :: ByteString
sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET_NUMBER :: ByteString
sDL_PROP_TEXTURE_VULKAN_TEXTURE_NUMBER :: ByteString
sDL_PROP_TEXTURE_GPU_TEXTURE_POINTER :: ByteString
sDL_PROP_TEXTURE_GPU_TEXTURE_UV_POINTER :: ByteString
sDL_PROP_TEXTURE_GPU_TEXTURE_U_POINTER :: ByteString
sDL_PROP_TEXTURE_GPU_TEXTURE_V_POINTER :: ByteString
sDL_RENDERER_VSYNC_DISABLED :: CInt
sDL_RENDERER_VSYNC_ADAPTIVE :: CInt
sDL_DEBUG_TEXT_FONT_CHARACTER_SIZE :: CInt
data SDL_GPURenderStateCreateInfo = SDL_GPURenderStateCreateInfo {
- fragment_shader :: Ptr SDL_GPUShader
- num_sampler_bindings :: Sint32
- sampler_bindings :: PtrConst SDL_GPUTextureSamplerBinding
- num_storage_textures :: Sint32
- storage_textures :: PtrConst (Ptr SDL_GPUTexture)
- num_storage_buffers :: Sint32
- storage_buffers :: PtrConst (Ptr SDL_GPUBuffer)
- props :: SDL_PropertiesID
}
data SDL_GPURenderState

Documentation

sDL_SOFTWARE_RENDERER :: ByteString Source #

C declaration: macro SDL_SOFTWARE_RENDERER, literal "software", defined at SDL3/SDL_render.h 75:9

sDL_GPU_RENDERER :: ByteString Source #

The name of the GPU renderer.

C declaration: macro SDL_GPU_RENDERER, literal "gpu", defined at SDL3/SDL_render.h 82:9

Since: 3.4.0

data SDL_Vertex Source #

Vertex structure.

C declaration: struct SDL_Vertex, defined at SDL3/SDL_render.h 89:16

Since: 3.2.0

Constructors

SDL_Vertex
Fields position :: SDL_FPoint Vertex position, in `SDL_Renderer` coordinates C declaration `position`, defined at `SDL3/SDL_render.h 91:16` color :: SDL_FColor Vertex color C declaration `color`, defined at `SDL3/SDL_render.h 92:16` tex_coord :: SDL_FPoint Normalized texture coordinates, if needed C declaration `tex_coord`, defined at `SDL3/SDL_render.h 93:16`

Instances

Instances details

Storable SDL_Vertex Source #

Instance details