---
name: "TTF_GetTextSubStringForPoint"
section: "3"
platform: "linux"
package: "libsdl3-ttf-doc"
version: "3.2.2+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/TTF_GetTextSubStringForPoint"
---

# TTF\_GetTextSubStringForPoint(3)

Get the portion of a text string that is closest to a point.

## NAME

TTF\_GetTextSubStringForPoint - Get the portion of a text string that is closest to a point.

## HEADER FILE

Defined in SDL3\_ttf/SDL\_ttf.h

## SYNOPSIS

```
#include "SDL3_ttf/SDL_ttf.h"
```

**bool TTF\_GetTextSubStringForPoint(TTF\_Text \*text, int x, int y, TTF\_SubString \*substring);**

## DESCRIPTION

This will return the closest substring of text to the given point.

## FUNCTION PARAMETERS

- *text*

  the  **TTF\_Text**\
    to query.

- *x*

  the x coordinate relative to the left side of the text, may be outside the bounds of the text area.

- *y*

  the y coordinate relative to the top side of the text, may be outside the bounds of the text area.

- *substring*

  a pointer filled in with the closest substring of text to the given point.

## RETURN VALUE

Returns true on success or false on failure; call SDL\_GetError() for more information.

## THREAD SAFETY

This function should be called on the thread that created the text.

## AVAILABILITY

This function is available since SDL\_ttf 3.0.0.