Contents Menu Expand Light mode Dark mode Auto light/dark mode
OpenMfx documentation
Light Logo Dark Logo
  • Introduction
  • Quick Start
    • Using OpenMfx
    • Your first OpenMfx plugin
    • Integrating OpenMfx as an host
  • Programming Guide
    • Writing an OpenMfx plugin
    • Getting started with the C++ SDK
    • Writing an OpenMfx plugin using the C API
    • Writing an OpenMfx host
  • SDK Reference
    • Plugin SDK
      • Macros
      • MfxAttribute
      • MfxAttributeProps
      • MfxBase
      • MfxEffect
      • MfxHost
      • MfxInput
      • MfxInputDef
      • MfxMesh
      • MfxMeshProps
      • MfxParam
      • MfxParamDef
      • MfxRegister
      • MfxSuiteException
    • Host SDK
      • Attributes
      • AttributeProps
      • AttributeEnums
      • Collection
      • EffectLibrary
      • EffectRegistry
      • EffectRegistryEntry
      • Host
      • Inputs
      • Mesh
      • MeshProps
      • MeshEffect
      • messages
      • ofxExtras
      • Parameters
      • ParameterEnums
      • Properties
      • PropertyEnums
      • Mesh Effect Suite
      • Message Suite
      • Parameter Suite
      • Property Suite
  • API Reference
    • The Mesh Effect API
    • Mesh Effect Suite
    • Actions Passed to a Mesh Effect
  • Implementations and Related Work
    • Available plugins
    • Available hosts
      • OpenMfx for Blender
  • Requests for Comments
    • RFC001 - Design Principles
    • RFC002 - Edge Representation
    • RFC003 - Constant Face Size
    • RFC004 - Renaming Vertex into Corner
    • RFC005 - Deform-only effects
    • RFC006 - Null stride for constant face size
    • RFC007 - Requesting attributes
    • RFC008 - Enumerating attributes
    • RFC009 - Dynamic linking hell
    • RFC010 - Mesh representation of common hosts
    • RFC011 - Non-mesh inputs/outputs
    • RFC012 - Arbitrary attributes on Point/Corner/Face
    • RFC013 - Renaming OpenMeshEffect into OpenMfx
    • RFC014 - Buffer Protocol
Back to top
Edit this page

API Reference#

This is the API reference, describing all functions and objects present in the OpenMfx API. If you are looking for a more didactic document, have a look at the programming guide: Programming Guide.

Recommended fore-reading Since OpenMfx is built on top of OpenFX, the reader should know about the bases of OpenFX Core by reading OpenFX documentation.

Contents#

  • The Mesh Effect API
  • Mesh Effect Suite
  • Actions Passed to a Mesh Effect
Next
The Mesh Effect API
Previous
Property Suite
Copyright © 2019-2022, Élie Michel and contributors
Made with Sphinx and @pradyunsg's Furo
On this page
  • API Reference
    • Contents