2 * Copyright 2008 ZXing authors
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
16 namespace com.google.zxing
\r
19 using ByteMatrix = com.google.zxing.common.ByteMatrix;
\r
20 /// <summary> The base class for all objects which encode/generate a barcode image.
\r
23 /// <author> dswitkin@google.com (Daniel Switkin)
\r
26 public interface Writer
\r
28 /// <summary> Encode a barcode using the default settings.
\r
31 /// <param name="contents">The contents to encode in the barcode
\r
33 /// <param name="format">The barcode format to generate
\r
35 /// <param name="width">The preferred width in pixels
\r
37 /// <param name="height">The preferred height in pixels
\r
39 /// <returns> The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)
\r
42 ByteMatrix encode(System.String contents, BarcodeFormat format, int width, int height);
\r
45 /// <param name="contents">The contents to encode in the barcode
\r
47 /// <param name="format">The barcode format to generate
\r
49 /// <param name="width">The preferred width in pixels
\r
51 /// <param name="height">The preferred height in pixels
\r
53 /// <param name="hints">Additional parameters to supply to the encoder
\r
55 /// <returns> The generated barcode as a Matrix of unsigned bytes (0 == black, 255 == white)
\r
58 ByteMatrix encode(System.String contents, BarcodeFormat format, int width, int height, System.Collections.Hashtable hints);
\r