Open Search
    Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
    PreviewImageSubscriptionInterface Class Reference

    #include <previewimagesubscription.h>

    Inheritance diagram for PreviewImageSubscriptionInterface:
    Inheritance graph
    [legend]

    Public Member Functions

    MAXON_METHOD Result< void > Activate (const GraphNode &node, PreviewImageSubscriptionResultFunc &&resultFunction)
     

    Static Public Member Functions

    static MAXON_METHOD Result< PreviewImageSubscriptionRef > Create ()
     

    Private Member Functions

     MAXON_INTERFACE (PreviewImageSubscriptionInterface, MAXON_REFERENCE_NORMAL, "net.maxon.nodes.interface.previewimagesubscription")
     

    Private Attributes

     MAXON_INTERFACE_SINGLE_IMPLEMENTATION
     

    Member Function Documentation

    ◆ MAXON_INTERFACE()

    MAXON_INTERFACE ( PreviewImageSubscriptionInterface  ,
    MAXON_REFERENCE_NORMAL  ,
    "net.maxon.nodes.interface.previewimagesubscription"   
    )
    		private

    ◆ Create()

    static MAXON_METHOD Result<PreviewImageSubscriptionRef> Create ( )
    		static

    Create a subscription.

    Returns
    The subscription on success.

    ◆ Activate()

    MAXON_METHOD Result<void> Activate ( const GraphNode &  node,
    PreviewImageSubscriptionResultFunc &&  resultFunction 
    )

    Submit the subscription request for a chosen node. The provided resultFunction may be called immediately, so make sure to not hold problematic locks. Releasing the reference PreviewImageSubscription results in automatic unsubscription.

    Parameters
    [in]nodeThe node for which previews should be provided.
    [in]resultFunctionThe delegate for preview image provision.
    Returns
    OK on success.

    Member Data Documentation

    ◆ MAXON_INTERFACE_SINGLE_IMPLEMENTATION

    MAXON_INTERFACE_SINGLE_IMPLEMENTATION
    		private