Function SDL_ConvertEventToRenderCoordinates

pub unsafe extern "C" fn SDL_ConvertEventToRenderCoordinates(
    renderer: *mut SDL_Renderer,
    event: *mut SDL_Event,
) -> bool

Available on crate feature dep_sdl3 only.

Convert the coordinates in an event to render coordinates.

This takes into account several states:

• The window dimensions.
• The logical presentation settings (SDL_SetRenderLogicalPresentation)
• The scale (SDL_SetRenderScale)
• The viewport (SDL_SetRenderViewport)

Various event types are converted with this function: mouse, touch, pen, etc.

Touch coordinates are converted from normalized coordinates in the window to non-normalized rendering coordinates.

Relative mouse coordinates (xrel and yrel event fields) are also converted. Applications that do not want these fields converted should use SDL_RenderCoordinatesFromWindow() on the specific event fields instead of converting the entire event structure.

Once converted, coordinates may be outside the rendering area.

Parameters

• renderer: the rendering context.
• event: the event to modify.

Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

Thread safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

See also

• SDL_RenderCoordinatesFromWindow