API Reference🔗

TouchPy Classes🔗

CUDADataType

The data type of a CUDA memory buffer

ChopChannels

Represents an array of floating point values.

Color

ColorPar

A color parameter in a TouchDesigner component

Comp

Representsa TouchDesigner component loaded in a TouchEngine instance.

CompFlags

Enumeration of component flags.

CudaFlags

Support for integer-based Flags

CudaMemory

A pointer to CUDA memory and its attributes

CudaMemoryDesc

DatTable

Represents a 2D table of strings.

Double2Par

A float2 parameter in a TouchDesigner component

Double3Par

A float3 parameter in a TouchDesigner component

Double4Par

A float4 parameter in a TouchDesigner component

Float2

Float3

Float4

InChop

Set data on an InCHOP in a loaded TouchDesigner component

InChops

A container of InChop objects.

InDat

An interface for an InDAT in a loaded TouchDesigner component

InDats

A container of InDat objects.

InTop

An interface for an InTOP in a loaded TouchDesigner component

InTops

A container of InTop objects.

Int2

Int2Par

An int2 parameter in a TouchDesigner component

Int3

Int3Par

An int3 parameter in a TouchDesigner component

Int4

Int4Par

An int4 parameter in a TouchDesigner component

LogLevel

Enumeration of logging levels.

OutChop

Access data in an OutCHOP in a loaded TouchDesigner component

OutChops

A container of OutChop objects.

OutDat

An interface for an OutDAT in a loaded TouchDesigner component

OutDats

A container of OutDat objects.

OutTop

An interface for an OutTOP in a loaded TouchDesigner component

OutTops

A container of OutTop objects

Par

A parameter in a TouchDesigner component

ParCollection

A collection of par Par objects

PulsePar

A pulse parameter in a TouchDesigner component

Time

A struct containing the time information of the currently loaded component.

Functions🔗

get_dlpack_capsule_info(→ dict)

Get information about a DLPack capsule.

init_logging(→ None)

Initialize the logging system.

set_log_level(→ None)

Set the logging level.

Module Contents🔗

touchpy.get_dlpack_capsule_info(array: numpy.typing.ArrayLike) dict🔗

Get information about a DLPack capsule.

Parameters:

array (ndarray) – The array to get information about.

Returns:

A dictionary containing information about the array.

Return type:

dict

touchpy.init_logging(
level: LogLevel = LogLevel.INFO,
console: bool = True,
file: bool = False,
) None🔗

Initialize the logging system.

Parameters:
  • level (LogLevel) – The logging level to use.

  • console (bool) – Whether to log to the console.

  • file (bool) – Whether to log to a file.

Returns:

None

touchpy.set_log_level(level: LogLevel = LogLevel.WARN) None🔗

Set the logging level.

Parameters:

level (LogLevel) – The logging level to use.

Returns:

None