Render Surfaces
PBRenderSurface
Opaque object handle: (not documented yet)
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 PBRenderSurfaceRetain; to decrement the reference count, call PBRenderSurfaceRelease. These functions are thread-safe.
PBBeginPaintingFlags
Enumeration/bitset of type uint32_t: (not documented yet)
Constants
PBBeginPainting_CLEAR
PBBeginPainting_CLEAR = 1<<0
(not documented yet)
PBBeginPainting_FOR_REPAINT
PBBeginPainting_FOR_REPAINT = 1<<1
(not documented yet)
PBRenderSurfaceCreateCompatibleWithElement
Function: (not documented yet)
Syntax (C/C++)
PBRenderSurfacePtr _Nullable PBRenderSurfaceCreateCompatibleWithElement(
PBElementRef compatibleElement, PBSize surfaceSizePx, bool isOpaque);
Syntax (Python)
RenderSurfaceCreateCompatibleWithElement(compatibleElement, surfaceSizePx, isOpaque) -> (surface)
Parameters and Return Values
[in] compatibleElement (referenced PBElement): (not documented yet)
[in] surfaceSizePx (PBSize): (not documented yet)
[in] isOpaque (bool
): (not documented yet)
[out] surface (nullable owned PBRenderSurface): (not documented yet)
PBRenderSurfaceBeginPainting
Function: (not documented yet)
Syntax (C/C++)
PBPainterPtr _Nullable PBRenderSurfaceBeginPainting(PBRenderSurfaceRef surface,
PBBeginPaintingFlags flags,
/* optional */ const PBRectangle * _Nullable __restrict initialClipRectangle);
Syntax (Python)
RenderSurfaceBeginPainting(surface, flags, initialClipRectangle) -> (painter)
Parameters and Return Values
[in] surface (referenced PBRenderSurface): (not documented yet)
[in] flags (PBBeginPaintingFlags): (not documented yet)
[optional-in] initialClipRectangle (PBRectangle): (not documented yet)
[out] painter (nullable owned PBPainter): (not documented yet)
PBRenderSurfaceEndPainting
Function: (not documented yet)
Syntax (C/C++)
void PBRenderSurfaceEndPainting(PBRenderSurfaceRef surface, PBPainterPtr painter);
Syntax (Python)
RenderSurfaceEndPainting(surface, painter)
Parameters and Return Values
[in] surface (referenced PBRenderSurface): (not documented yet)
[in] painter (owned PBPainter): (not documented yet)
PBRenderSurfaceGetContentsLostFlag
Function: (not documented yet)
Syntax (C/C++)
bool PBRenderSurfaceGetContentsLostFlag(PBRenderSurfaceRef surface,
bool clearFlag);
Syntax (Python)
RenderSurfaceGetContentsLostFlag(surface, clearFlag) -> (contentsLostFlag)
Parameters and Return Values
[in] surface (referenced PBRenderSurface): (not documented yet)
[in] clearFlag (bool
): (not documented yet)
[out] contentsLostFlag (bool
): (not documented yet)
PBRenderSurfaceGetSize
Function: (not documented yet)
Syntax (C/C++)
PBSize PBRenderSurfaceGetSize(PBRenderSurfaceRef surface);
Syntax (Python)
RenderSurfaceGetSize(surface) -> (sizePx)
Parameters and Return Values
[in] surface (referenced PBRenderSurface): (not documented yet)
[out] sizePx (PBSize): (not documented yet)