.. _group__a3d__markup__module:

#############
Markup Module
#############

Creates and accesses markup entities.

Entity type is :c:enumerator:`~kA3DTypeMkpMarkup`\ .

There may be a tessellation in the markup and in each leader. The following sample code shows how to retrieve the tessellation.


Sample code
===========


::

   /*codetogetthetessellationofamarkuporaleader*/
   /*pTessisaA3DTessMarkup**/
   A3DTessBaseDatasBaseData=A3D_MAKE_DATA(A3DTessBaseData);
   A3DInt32iErr=A3DTessBaseGet((A3DTessBase*)pTess,&sBaseData);
   if(iErr==A3D_SUCCESS)
   {
   A3DTessMarkupDatasData=A3D_MAKE_DATA(A3DTessMarkupData);
   iErr=A3DTessMarkupGet(pTess,&sData);
   if(iErr==A3D_SUCCESS)
   {
   /*thetessellationisdescribedinsBaseDataplussData*/
   }
   A3DTessMarkupGet(A3D_NULL_HANDLE,&sData);
   }
   A3DTessBaseGet(A3D_NULL_HANDLE,&sData);


   :ref:`Tessellation for Markups <group__a3d__tessmarkup>`



**Parameters**


   **pMarkup**\ : The :c:type:`~A3DMkpMarkup`\ entity to get linked item list from. If NULL, pppLinkedItems is freed instead of being allocated.

   **puiLinkedItemsSize**\ : The number of :c:type:`~A3DMiscMarkupLinkedItem`\ in the resulting array.

   **ppLinkedItems**\ : The resulting array.


**Returns**


   ``A3D_SUCCESS``\ on success, or an error code on failure


.. rst-class:: kind-group kind-topic

.. rubric:: Topics
   :class: kind-group-title


.. rst-class:: api-xref-list


* :ref:`Markup Types and Subtypes <group__a3d__markup__enums>`
* :ref:`Markup definition <group__a3d__markupdefinition__module>`
* :ref:`Markup Leader <group__a3d__markupleader>`
* :ref:`Annotations Entity <group__a3d__annotationentity>`
* :ref:`View <group__a3d__annots__view>`
* :ref:`Markup Linked Item <group__a3d__markuplinkeditem>`
* :ref:`RTF parsing <group__a3d__markup__rtf>`
* :ref:`Fonts <group__a3d__fonts>`

.. rst-class:: kind-group kind-record

.. rubric:: Structures
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:struct:`~A3DMkpMarkupData`

.. rst-class:: kind-group kind-function

.. rubric:: Functions
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:func:`~A3DMkpMarkupGet`
* :c:func:`~A3DMkpMarkupCreate`
* :c:func:`~A3DMkpLinkForMarkupReferenceGet`
* :c:func:`~A3DMkpLinkForAdditionalMarkupReferenceGet`
* :c:func:`~A3DMkpMarkupSet`
* :c:func:`~A3DMkpDatumTargetSetDatumOwner`
* :c:func:`~A3DMkpAddMarkupLinkedItemTag`

.. toctree::
   :maxdepth: 1
   :hidden:

   a3d_markup_enums
   a3d_markupdefinition_module
   a3d_markupleader
   a3d_annotationentity
   a3d_annots_view
   a3d_markuplinkeditem
   a3d_markup_rtf
   a3d_fonts
   ../structures/A3DMkpMarkupData
   ../functions/A3DMkpMarkupGet
   ../functions/A3DMkpMarkupCreate
   ../functions/A3DMkpLinkForMarkupReferenceGet
   ../functions/A3DMkpLinkForAdditionalMarkupReferenceGet
   ../functions/A3DMkpMarkupSet
   ../functions/A3DMkpDatumTargetSetDatumOwner
   ../functions/A3DMkpAddMarkupLinkedItemTag


