
####################################
A3DGlobalGetGraphVPicturePatternData
####################################

.. c:function:: A3DStatus A3DGlobalGetGraphVPicturePatternData(const A3DUns32 uiIndexVPicturePattern, A3DGraphVPicturePatternData *pData)

   .. rst-class:: sig-pretty-signature
   
      | :c:enum:`~A3DStatus` A3DGlobalGetGraphVPicturePatternData(*const* :c:type:`~A3DUns32` **uiIndexVPicturePattern**\ , :c:struct:`~A3DGraphVPicturePatternData`\ \* **pData**\ )
   
   Retrieves an ``A3DGraphVPicturePatternData`` instance.
   
   
      2.0
   
   
   HOOPS stores pattern information in a global state using indexes. When given an index, call ``A3DGlobalInsertGraphVPicturePattern`` to fill in an ``A3DGraphVPicturePatternData`` instance.
   
   **Return Values**
   
   
      **A3D_SUCCESS**\ : in case of success.
   
      **A3D_INITIALIZE_NOT_CALLED**\ : if the library is not initialized
   
      **A3D_INVALID_PATTERN_INDEX**\ : if ``uiIndexVPicturePattern`` does not match any existing.
   
      **A3D_BASEWITHGRAPHICS_BAD_ENTITY_TYPE**\ : if ``uiIndexVPicturePattern`` is invalid but indexes an other pattern type (either ``A3DGraphDottingPatternData``\ , ``A3DGraphSolidPatternData`` or ``A3DGraphVPicturePatternData``\ )
   
      **A3D_INVALID_DATA_STRUCT_NULL**\ : if ``pData`` is null.
   
      **A3D_INVALID_DATA_STRUCT_SIZE**\ : if ``pData`` is incorrectly initialized
   
   
   .. code-block:: c
   
      // Retrieves the pattern data at index 3:
      A3DGraphVPicturePatternData pattern_data = A3D_MAKE_DATA(A3DGraphVPicturePatternData);
      A3DStatus result = A3DGlobalGetGraphVPicturePatternData(3, &pattern_data);
      
      assert(result == A3D_SUCCESS);
      Retrieve tessellation base and markup data:
      if(pattern_data.m_pMarkupTess != 0) {
          A3DTessBaseData tess_base = A3D_MAKE_DATA(A3DTessBaseData);
          result = A3DTessBaseGet(pattern_data.m_pMarkupTess, &tess_base);
          assert(result == A3D_SUCCESS);
      
          A3DTessMarkupData tess_markup = A3D_MAKE_DATA(A3DTessMarkupGet);
          result = A3DTessMarkupGet(pattern_data.m_pMarkupTess, &tess_markup);
          assert(result == A3D_SUCCESS);
      
          // ...
          A3DTessMarkupGet(0, &tess_markup);
          A3DTessBaseGet(0, &tess_base);
      }
   
   
   ..
   
      :c:struct:`~A3DGraphVPicturePatternData`
   
   
   
      :c:func:`~A3DGlobalInsertGraphVPicturePattern`
   
   
   
      :c:func:`~A3DTessBaseGet`
   
   
   
      :c:func:`~A3DTessMarkupGet`
   
   
   
      :c:struct:`~A3DTessBaseData`
   
   
   
      :c:struct:`~A3DTessMarkupData`
   
   
   
      :c:struct:`~A3DGraphDottingPatternData`
   
   
   
      :c:struct:`~A3DGraphSolidPatternData`
   
   
   
      :c:struct:`~A3DGraphVPicturePatternData`
   
   
   **Parameters**
   
   
      **uiIndexVPicturePattern**\ : The index of the pattern.
   
      **pData**\ : The ``A3DGraphVPicturePatternData`` to fill in.
   
   
   **Returns**
   
   
      ``A3D_SUCCESS`` or an error code in case of failure.
   
   




