DiffusionGenerationOptions class

Available extensions

Constructors

DiffusionGenerationOptions({String? prompt, String? negativePrompt, int? width, int? height, int? steps, double? guidanceScale, Int64? seed, DiffusionScheduler? scheduler, List<int>? image, List<int>? maskImage, double? strength, String? imageMediaType, String? maskImageMediaType, int? n, DiffusionOutputFormat? outputFormat})
factory
DiffusionGenerationOptions.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
DiffusionGenerationOptions.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

guidanceScale ↔ double
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
height ↔ int
getter/setter pair
image ↔ List<int>
Source picture. Its presence promotes the request to image-to-image; adding mask_image promotes it to inpainting. Must be an encoded PNG or JPEG container.
getter/setter pair
imageMediaType ↔ String
Container of the bytes above, as supplied by the caller. Request-side; the result carries its own media type per image.
getter/setter pair
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
maskImage ↔ List<int>
White = repaint. Same dimensions as image.
getter/setter pair
maskImageMediaType ↔ String
getter/setter pair
n ↔ int
How many images to generate for this prompt. Absent = 1.
getter/setter pair
negativePrompt ↔ String
getter/setter pair
outputFormat ↔ DiffusionOutputFormat
Encoding of the returned image bytes.
getter/setter pair
prompt ↔ String
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduler ↔ DiffusionScheduler
getter/setter pair
seed ↔ Int64
Absent = pick a fresh random seed. Any present value is literal, including 0. The seed actually used comes back on each result image.
getter/setter pair
steps ↔ int
getter/setter pair
strength ↔ double
How far from the source image to travel. Only meaningful with image. Effective steps = ceil(steps * strength), so a low value is proportionally cheaper -- on device that is battery.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
width ↔ int
0 = backend default, for width, height, steps, and guidance_scale.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearGuidanceScale() → void
clearHeight() → void
clearImage() → void
clearImageMediaType() → void
clearMaskImage() → void
clearMaskImageMediaType() → void
clearN() → void
clearNegativePrompt() → void
clearOutputFormat() → void
clearPrompt() → void
clearScheduler() → void
clearSeed() → void
clearSteps() → void
clearStrength() → void
clearWidth() → void
clone() → DiffusionGenerationOptions
Creates a deep copy of the fields in this message.
copyWith(void updates(DiffusionGenerationOptions)) → DiffusionGenerationOptions
Apply updates to a copy of this message.
createEmptyInstance() → DiffusionGenerationOptions
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasGuidanceScale() → bool
hasHeight() → bool
hasImage() → bool
hasImageMediaType() → bool
hasMaskImage() → bool
hasMaskImageMediaType() → bool
hasN() → bool
hasNegativePrompt() → bool
hasOutputFormat() → bool
hasPrompt() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasScheduler() → bool
hasSeed() → bool
hasSteps() → bool
hasStrength() → bool
hasWidth() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
validate() → void

Available on DiffusionGenerationOptions, provided by the DiffusionGenerationOptionsValidate extension

writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited