image/DecoderFlags.h
author Mozilla Releng Treescript <release+treescript@mozilla.org>
Tue, 04 Sep 2018 19:18:19 +0000
changeset 492326 d80205c8ffa6be6bceb5a0135628b6c81e89ecf0
parent 430942 c856f513264340a2d6c2b70f71f345b5e4c8d6c0
child 495278 1b1e25b0b345cf3774ae7d186dc082430420e056
permissions -rw-r--r--
No bug - Tagging 0269319281578bff4e01d77a21350bf91ba08620 with DEVEDITION_63_0b3_BUILD1 a=release CLOSED TREE DONTBUILD

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_image_DecoderFlags_h
#define mozilla_image_DecoderFlags_h

#include "mozilla/TypedEnumBits.h"

namespace mozilla {
namespace image {

/**
 * Flags that influence decoder behavior. Note that these flags *don't*
 * influence the logical content of the surfaces that the decoder generates, so
 * they're not in a factor in SurfaceCache lookups and the like. These flags
 * instead either influence which surfaces are generated at all or the tune the
 * decoder's behavior for a particular scenario.
 */
enum class DecoderFlags : uint8_t
{
  FIRST_FRAME_ONLY               = 1 << 0,
  IS_REDECODE                    = 1 << 1,
  IMAGE_IS_TRANSIENT             = 1 << 2,
  ASYNC_NOTIFY                   = 1 << 3,

  /**
   * By default, a surface is considered substitutable. That means callers are
   * willing to accept a less than ideal match to display. If a caller requires
   * a specific size and won't accept alternatives, then this flag should be
   * set.
   */
  CANNOT_SUBSTITUTE              = 1 << 4
};
MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS(DecoderFlags)

/**
 * @return the default set of decode flags.
 */
inline DecoderFlags
DefaultDecoderFlags()
{
  return DecoderFlags();
}

} // namespace image
} // namespace mozilla

#endif // mozilla_image_DecoderFlags_h