Source bitmap recipe

Source bitmap recipe

The source_bitmap_info XML element describes the transparency status of the source bitmap.

XML structure

<source_bitmap_info        <!-- Root element: source bitmap information -->
        transparent="false"          <!-- Indicates whether the source bitmap contains transparent pixels -->
/>

Usage

The source_bitmap_info XML string is returned in the output of:

  1. api/bitmapArtPreview

Attribute

The transparent attribute indicates whether the input bitmap includes transparent pixels.
Values
Details
true
The image contains transparency — e.g. PNG with alpha.
false
The image is fully opaque.

Remarks·        

  1. This element is primarily used for reference or diagnostic purposes.
  2. It helps downstream systems or UIs determine whether background removal — e.g. via remove_background — is necessary or already handled.
  3. Only appears in output; not part of the request payload.

    • Related Articles

    • Capture design bitmap

      The Capture Design Bitmap feature allows you to create and download a bitmap image of a design stored in Wilcom Library. Bitmap previews are useful for sharing design visuals with customers, including designs in documentation, or referencing designs ...

    • EWA API getting started

      These notes guide developers through the initial setup, authentication, API calling structure, and development tools available for integrating the Wilcom Embroidery Web API into web applications. ✅ Step 1: Sign up and get API credentials Visit the ...

    • EWA API technical notes

      Wilcom’s Embroidery Web API is a cloud-hosted, RESTful interface that enables developers to integrate professional embroidery design and personalization features into websites, e-commerce platforms, or internal systems. The API supports rendering, ...

    • Use case: golf club personalized garments

      A golf club wants to let members order embroidered polo shirts and other merchandise, personalized with their own names (or names of family and friends). Step 1: Design preparation in EmbroideryStudio In Wilcom EmbroideryStudio, create a lettering ...

    • Supported file formats

      The Wilcom Embroidery Web API supports a wide range of embroidery-specific and artwork input/output formats to ensure compatibility with professional embroidery workflows and machine types. This format support enables seamless integration across ...