ImageVectorOutput()

Syntax

VectorOutputID = ImageVectorOutput(#Image [, Unit])
Description
Returns the OutputID of the image to perform 2D vector drawing operations on it. If the image is multi-frame, the current frame will be used.

Parameters

#Image The image to draw on.
Unit (optional) Specifies the unit used for measuring distances on the drawing output. The default unit for images is #PB_Unit_Pixel.
  #PB_Unit_Pixel     : Values are measured in pixels (or dots in case of a printer)
  #PB_Unit_Point     : Values are measured in points (1/72 inch)
  #PB_Unit_Inch      : Values are measured in inches
  #PB_Unit_Millimeter: Values are measured in millimeters

Return value

Returns the output ID or zero if drawing is not possible. This value should be passed directly to the StartVectorDrawing() function to start the drawing operation. The return-value is valid only for one drawing operation and cannot be reused.

Example

  StartVectorDrawing(ImageVectorOutput(#Image, #PB_Unit_Millimeter))
    ; do some drawing stuff here...
  StopVectorDrawing()

Remarks

This command cannot be used with loaded icon files (*.ico).

See Also

StartVectorDrawing(), ImageOutput()

Supported OS

All

<- ImageOutput() - Image Index - ImageWidth() ->