--- # Copyright 2025 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. layout: docs docs_language: c scripts: - docs/c ---
{% if page.group.basalt_only %}

The APIs on this page will only work with SDK 3.x.

{% endif %} {% if_starts_with page.path 'docs/c/preview/' %} {% include docs/c/preview.html %} {% endif_starts_with %}

{{ page.title }}

{{ page.group.summary }} {{ page.group.description }} {% include docs/c/elements/note.html data=page.group.data %} {% include docs/c/elements/see.html data=page.group.data %} {% if page.group.groups.size > 0 %}

Modules

{% for group in page.group.groups %}

{{ group.name }}

{% if group.summary.size > 0 %} {{ group.summary }} {% else %}

 

{% endif %}
{% endfor %} {% endif %} {% if page.group.functions.size > 0 %}

Function

{% for function in page.group.functions %}
{% if function.uniform %} {% include docs/c/function.html function=function platform='basalt' %} {% else %} {% include docs/c/elements/tabs.html %} {% for platform in page.platforms %} {% if function.platforms contains platform %}
{% include docs/c/function.html function=function platform=platform %}
{% else %} {% include docs/c/elements/missing.html platform=platform name=function.name type='function' %} {% endif %} {% endfor %} {% endif %}
{% endfor %} {% endif %} {% if page.group.structs.size > 0 %}

Data Structure

{% for struct in page.group.structs %}
{% if struct.uniform %} {% include docs/c/struct.html struct=struct platform='basalt' %} {% else %} {% include docs/c/elements/tabs.html %} {% for platform in page.platforms %} {% if struct.platforms contains platform %}
{% include docs/c/struct.html struct=struct platform=platform %}
{% else %} {% include docs/c/elements/missing.html platform=platform name=struct.name type='struct' %} {% endif %} {% endfor %} {% endif %}
{% endfor %} {% endif %} {% if page.group.unions.size > 0 %}

Union

{% for union in page.group.unions %}
{% if union.uniform %} {% include docs/c/struct.html struct=union platform='basalt' %} {% else %} {% include docs/c/elements/tabs.html %} {% for platform in page.platforms %} {% if union.platforms contains platform %}
{% include docs/c/struct.html struct=union platform=platform %}
{% else %} {% include docs/c/elements/missing.html platform=platform name=union.name type='union' %} {% endif %} {% endfor %} {% endif %}
{% endfor %} {% endif %} {% if page.group.enums.size > 0 %}

Enum

{% for enum in page.group.enums %}
{% if enum.uniform %} {% include docs/c/enum.html enum=enum platform='basalt' %} {% else %} {% include docs/c/elements/tabs.html %} {% for platform in page.platforms %} {% if enum.platforms contains platform %}
{% include docs/c/enum.html enum=enum platform=platform %}
{% else %} {% include docs/c/elements/missing.html platform=platform name=enum.name type='enum' %} {% endif %} {% endfor %} {% endif %}
{% endfor %} {% endif %} {% if page.group.typedefs.size > 0 %}

Typedef

{% for typedef in page.group.typedefs %}
{% if typedef.uniform %} {% include docs/c/typedef.html typedef=typedef platform='basalt' %} {% else %} {% include docs/c/elements/tabs.html %} {% for platform in page.platforms %} {% if typedef.platforms contains platform %}
{% include docs/c/typedef.html typedef=typedef platform=platform %}
{% else %} {% include docs/c/elements/missing.html platform=platform name=typedef.name type='typedef' %} {% endif %} {% endfor %} {% endif %}
{% endfor %} {% endif %} {% if page.group.defines.size > 0 %}

Macro Definition

{% for define in page.group.defines %}
{% if define.uniform %} {% include docs/c/define.html define=define platform='basalt' %} {% else %} {% include docs/c/elements/tabs.html %} {% for platform in page.platforms %} {% if define.platforms contains platform %}
{% include docs/c/define.html define=define platform=platform %}
{% else %} {% include docs/c/elements/missing.html platform=platform name=define.name type='define' %} {% endif %} {% endfor %} {% endif %}
{% endfor %} {% endif %}