Transition Panels

PBTransitionPanel

Opaque object handle:

This is a subclass of PBElement. You can safely cast from PBTransitionPanel to PBElement. To cast from PBElement to PBTransitionPanel, call PBTransitionPanelCast; this performs a runtime assertion to check the cast is possible. This function is thread-safe.

This object maintains an internal reference count. When the reference count reaches zero, the object will be automatically deallocated. To increment the reference count, call PBElementRetain; to decrement the reference count, call PBElementRelease. These functions are thread-safe.

PBTransitionPanelFlags

Enumeration/bitset of type uint32_t:

Constants

PBTransitionPanel_BLOCK_MOUSE_INTERACTION_DURING_TRANSITIONS

PBTransitionPanel_BLOCK_MOUSE_INTERACTION_DURING_TRANSITIONS = 1<<0

Or any of the values from PBElementFlags.

PBTransitionType

Enumeration/bitset of type uint32_t:

Constants

PBTransitionType_PUSH_FROM_LEFT

PBTransitionType_PUSH_FROM_LEFT = 1

PBTransitionType_PUSH_FROM_RIGHT

PBTransitionType_PUSH_FROM_RIGHT = 2

PBTransitionType_PUSH_FROM_TOP

PBTransitionType_PUSH_FROM_TOP = 3

PBTransitionType_PUSH_FROM_BOTTOM

PBTransitionType_PUSH_FROM_BOTTOM = 4

PBTransitionType_CROSS_FADE

PBTransitionType_CROSS_FADE = 5

PBTransitionFlags

Enumeration/bitset of type uint32_t:

Constants

PBTransition_NO_PREVIOUS_FRAME

PBTransition_NO_PREVIOUS_FRAME = 1<<0

PBTransition_NO_CURRENT_FRAME

PBTransition_NO_CURRENT_FRAME = 1<<1

PBTransition_USE_CAPACITOR

PBTransition_USE_CAPACITOR = 1<<2

PBMessageTransitionComplete

Structure:

Fields

[in] identifier (PBUserContext):

[in] replaced (bool):

PBTransitionPanelCreate

Function:

Syntax (C/C++)

PBTransitionPanelPtr _Nullable PBTransitionPanelCreate(PBElementRef parent, 
    PBTransitionPanelFlags flags);

Syntax (Python)

TransitionPanelCreate(parent, flags) -> (panel)

Parameters and Return Values

[in] parent (referenced PBElement):

[in] flags (PBTransitionPanelFlags):

[out] panel (nullable owned PBTransitionPanel):

PBTransitionPanelStartTransition

Function:

Syntax (C/C++)

void PBTransitionPanelStartTransition(PBTransitionPanelRef panel, 
    PBTransitionType type, float durationSeconds, PBUserContext identifier, 
    PBTransitionFlags flags);

Syntax (Python)

TransitionPanelStartTransition(panel, type, durationSeconds, identifier, flags)

Parameters and Return Values

[in] panel (referenced PBTransitionPanel):

[in] type (PBTransitionType):

[in] durationSeconds (float):

[in] identifier (PBUserContext):

[in] flags (PBTransitionFlags):

Guide

API Reference