---
name: "xosd_create"
section: "3"
platform: "linux"
package: "xosd"
version: "2.2.14-12"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/xosd_create"
---

# xosd\_create(3)

Create a new XOSD object

## NAME

xosd\_create - Create a new XOSD object

## SYNOPSIS

\#include \<xosd.h\>

xosd \***xosd\_create** (int *number\_lines*);

## DESCRIPTION

**xosd\_init** creates a new xosd window that can be used to display textual or numerical data on a X11 display in a unmanaged, shaped window that appears to be transparent. It provides a similar effect to the on-screen display of many televisions and video recorders.

## ARGUMENTS

- *number\_lines*

  The maximum number of lines of text that the window can display. This value cannot be changed.

## RETURN VALUE

On success a pointer to a new *xosd* object is returned, otherwise *NULL* is returned.

## ENVIRONMENT

- **DISPLAY**

  The environment variable that determines which X11 display the XOSD window appears.

- *char \*xosd\_error*

  A string to a text string describing the error.

## HISTORY

The **xosd\_create** function first appeared in version 2.0 of the XOSD library, replacing the now depricated **xosd\_init** function.

## AUTHORS

The XOSD library was originally written by André Renaud, and is currenly maintained by Tim Wright. This document was written by Michael JasonSmith.

## BUGS

There are no known bugs with **xosd\_create**. Bug reports can be sent to \<xosd@ignavus.net\>.

## SEE ALSO

 [**xosd\_destroy**(3)](/xosd_destroy/3.md), [**xosd\_show**(3)](/xosd_show/3.md), [**xosd\_set\_pos**(3)](/xosd_set_pos/3.md), [**xosd\_set\_align**(3)](/xosd_set_align/3.md), [**xosd\_set\_shadow\_offset**(3)](/xosd_set_shadow_offset/3.md), **xosd\_set\_offset**(3), **xosd\_set\_timeout**(3), **xosd\_set\_colour**(3), **xosd\_set\_font**(3), [**xosd\_show**(3)](/xosd_show/3.md), **xosd\_scroll**(3).