Scroll to navigation

MIX_GetGroupProperties(3) SDL_mixer3 FUNCTIONS MIX_GetGroupProperties(3)

NAME

MIX_GetGroupProperties - Get the properties associated with a group.

HEADER FILE

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS

#include "SDL3_mixer/SDL_mixer.h"
SDL_PropertiesID MIX_GetGroupProperties(MIX_Group *group);

DESCRIPTION

Currently SDL_mixer assigns no properties of its own to a group, but this can be a convenient place to store app-specific data.

A SDL_PropertiesID is created the first time this function is called for a given group.

FUNCTION PARAMETERS

the group to query.

RETURN VALUE

Returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL_mixer 3.0.0.

SDL_mixer 3.1.0 SDL_mixer