Global Opacity

Image Operations / Global Opacity

On this page:
Intro ▾
{{activeSubMenu.text}} ▾

This operation allows you to control the opacity (alpha) of the output images. Please note that internally, Pixaven applies global opacity adjustments right before passing the pixel data to the encoders. This means that changes to opacity will also be made to any applied filters, watermarks or masks.

The default background color is white for image formats without the support for alpha-transparency such as JPEG. For image formats which support alpha-transparency such as PNG, a fully transparent background will be used.

In order to adjust the opacity of your visuals simply add opacity key to your request JSON with a positive float within the range 0.01 - 1.00:

{
    "opacity": 0.65
}

An example cURL request of using Image Fetch method with opacity controls will look like below. We will also use PNG as output format:

curl https://api.pixaven.com/1.0/fetch
     --user your-api-key: \
     --header "Content-Type: application/json" \
     --data '{
         "url": "https://www.website.com/image.jpg",
         "opacity": 0.65,
         "output": {
             "format": "png"
         }
     }'
Adjusted
Original

Code Examples for Opacity Controls

Below, you'll find examples of how to use the Opacity Controls from the Pixaven API:

<?php

/**
* Instantiate new `$pix` by calling a constructor
*/

$pix = new Pixaven\Pixaven('your-api-key');


/**
* Provide a publicly available image URL with fetch(string) method
* and reduce the opacity of the output image to 0.65
*/

$pix
    ->fetch('https://www.website.com/image.jpg')
    ->opacity(0.65)
    ->toJSON(function ($error, $meta) {
        if (!empty($error)) {
            throw new Exception($error);
        }

        /**
        * You'll find the full JSON metadata array within the `$meta` variable.
        * Remember to always check if the `success` property is set to `true`.
        */

        if ($meta['success'] == true) {
            print ($meta['output']['url']);
        } else {
            print ($meta['message']);
        }
    });
/**
* Module dependencies
*/

const Pixaven = require("pixaven");


/**
* Instantiate new `pix` by calling a constructor
*/

const pix = new Pixaven("your-api-key");


/**
* Provide a publicly available image URL with fetch(string) method
* and reduce the opacity of the output image to 0.65
*/

pix
    .fetch("https://www.website.com/image.jpg")
    .opacity(0.65)
    .toJSON((err, meta) => {
        if (err) {
            return console.log(err);
        }

        /**
        * You'll find the full JSON metadata hash within the `meta` variable.
        * Remember to always check if the `success` property is set to `true`.
        */

        if (meta.success) {
            console.log(meta.output.url);
        } else {
            console.log(meta.message);
        }
    });
##
# Require dependencies

require "pixaven"


##
# Instantiate new `pix` by calling a constructor

pix = Pixaven.new("your-api-key")


##
# Provide a publicly available image URL with fetch(string) method
# and reduce the opacity of the output image to 0.65

err, meta = pix
    .fetch("https://www.website.com/image.jpg")
    .opacity(0.65)
    .to_json

abort(err) if err


##
# You'll find the full JSON metadata hash within the `meta` variable.
# Remember to always check if the `success` property is set to `true`.

if meta["success"]
    puts meta["output"]["url"]
else
    puts meta["message"]
end
package main

import (
    "fmt"
    "github.com/pixaven/pixaven-go"
)

func main() {

    /**
    * Instantiate new `pix` by calling a constructor
    */

    pix, err := pixaven.NewClient("your-api-key")

    if err != nil {
        panic(err)
    }


    /**
    * Provide a publicly available image URL with Fetch(string) method
    * and reduce the opacity of the output image to 0.65
    */

    meta, err := pix.
        Fetch("https://www.website.com/image.jpg").
        Opacity(0.65).
        ToJSON()

    if err != nil {
        panic(err)
    }


    /**
    * You'll find the full JSON metadata hash within the `meta` variable.
    * Remember to always check if the `success` property is set to `true`.
    */

    if meta["success"].(map[string]interface{})["success"].(bool) {
        fmt.Println(meta["output"].(map[string]interface{})["url"])
    } else {
        fmt.Println(meta["message"])
    }
}
##
# Import dependencies

from pixaven import pixaven


##
# Instantiate new `client` by calling a constructor

client = pixaven('your-api-key')


##
# Provide a publicly available image URL with fetch(string) method
# and reduce the opacity of the output image to 0.65

err, meta = (
    client
        .fetch('https://www.website.com/image.jpg')
        .opacity(0.65)
        .toJSON()
)

if err is not None:
    raise StandardError(err)


##
# You'll find the full JSON metadata hash within the `meta` variable.
# Remember to always check if the `success` property is set to `true`.

if meta['success'] is True:
    print (meta['output']['url'])
else:
    print (meta['message'])
package com.pixaven.examples;

/**
* Import dependencies
*/

import static com.pixaven.OperationConfiguration.settings;
import com.pixaven.Pixaven;
import com.pixaven.Fetch;
import com.pixaven.Response;

public class Masking {
    public static void main(String[] args) {

        /**
        * Instantiate new `pix` by calling a constructor
        */

        Pixaven pix = new Pixaven("your-api-key");

        /**
        * Provide a publicly available image URL with fetch(string) method
        * and reduce the opacity of the output image to 0.65
        */

        final Fetch fetch = pix.fetch("https://www.website.com/image.jpg");

        fetch.opacity(0.65);

        final Response response = fetch.toJson();

        /**
        * You'll find the full JSON metadata hash within the `Response#getMetadata()` property.
        * Remember to always check if the `Response#successful` property is set to `true`.
        */

        if (response.isSuccessful()) {
            System.out.println(response.getMetadata().getOutput().get("url"));
        } else {
            System.out.println(response.getMessage());
        }
    }
}

We use both proprietary and third-party cookies to improve your browsing experience and to provide you with a better service. By continuing to use this site you consent our use of cookies as described in our Cookie Policy×