DiffusionGenerationOptions class

Per-call generation options. Sources pre-IDL: Swift DiffusionTypes.swift:341 (DiffusionGenerationOptions) Kotlin DiffusionTypes.kt:230 (DiffusionGenerationOptions) RN DiffusionTypes.ts:114 (DiffusionGenerationOptions) Web DiffusionTypes.ts:29 (DiffusionGenerationOptions) C ABI rac_diffusion_types.h:187 (rac_diffusion_options_t)

Drift note: pre-IDL Swift/Kotlin/RN carry additional fields that the v1 IDL deliberately drops from this message in favor of more general / future carriers:

  • input_image / mask_image (bytes) → flows through a separate input artifact message in the service IDL
  • denoise_strength (float) → deferred (img2img-only, not in spec)
  • report_intermediate_images / progress_stride → covered by DiffusionProgress streaming semantics
Available extensions

Constructors

DiffusionGenerationOptions({String? prompt, String? negativePrompt, int? width, int? height, int? numInferenceSteps, double? guidanceScale, Int64? seed, DiffusionScheduler? scheduler, DiffusionMode? mode, List<int>? inputImage, List<int>? maskImage, double? denoiseStrength, bool? reportIntermediateImages, int? progressStride, int? inputImageWidth, int? inputImageHeight, String? inputImageMediaType, String? maskImageMediaType, int? batchSize, bool? returnLatents})
factory
DiffusionGenerationOptions.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
DiffusionGenerationOptions.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

batchSize ↔ int
getter/setter pair
denoiseStrength ↔ double
getter/setter pair
guidanceScale ↔ double
Classifier-free guidance scale. 0.0 = no CFG (required for SDXS / SDXL_Turbo). Typical SD range 1.0–20.0; default 7.5.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
height ↔ int
Output image height in pixels. 0 = use variant default.
getter/setter pair
info_ → BuilderInfo
no setter
inputImage ↔ List<int>
Image-to-image / inpainting payloads from rac_diffusion_options_t.
getter/setter pair
inputImageHeight ↔ int
getter/setter pair
inputImageMediaType ↔ String
Input image/mask media hints. Empty = backend infer/default.
getter/setter pair
inputImageWidth ↔ int
Dimensions for raw input_image payloads when the backend cannot infer them from an encoded container.
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
maskImage ↔ List<int>
getter/setter pair
maskImageMediaType ↔ String
getter/setter pair
mode ↔ DiffusionMode
Generation mode (txt2img / img2img / inpainting). UNSPECIFIED = TEXT_TO_IMAGE.
getter/setter pair
negativePrompt ↔ String
Things to avoid in the image. Empty = no negative prompt.
getter/setter pair
numInferenceSteps ↔ int
Number of denoising steps. Range 1–50 (variant-dependent: SDXS=1, SDXL_Turbo / LCM=4, SD*=20–28). 0 = use variant default.
getter/setter pair
progressStride ↔ int
getter/setter pair
prompt ↔ String
Text prompt describing the desired image. Required.
getter/setter pair
reportIntermediateImages ↔ bool
Progress reporting controls.
getter/setter pair
returnLatents ↔ bool
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduler ↔ DiffusionScheduler
Sampler algorithm. UNSPECIFIED = backend picks (recommended: DPMPP_2M_KARRAS).
getter/setter pair
seed ↔ Int64
RNG seed for reproducibility. -1 = pick a random seed.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
width ↔ int
Output image width in pixels. 0 = use variant default (512 for SD 1.5 / SDXS / LCM, 768 for SD 2.1, 1024 for SDXL / Turbo).
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
clearBatchSize() → void
clearDenoiseStrength() → void
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
clearInputImage() → void
clearInputImageHeight() → void
clearInputImageMediaType() → void
clearInputImageWidth() → void
clearMaskImage() → void
clearMaskImageMediaType() → void
clearMode() → void
clearNegativePrompt() → void
clearNumInferenceSteps() → void
clearProgressStride() → void
clearPrompt() → void
clearReportIntermediateImages() → void
clearReturnLatents() → void
clearScheduler() → void
clearSeed() → 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
hasBatchSize() → bool
hasDenoiseStrength() → bool
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
hasInputImage() → bool
hasInputImageHeight() → bool
hasInputImageMediaType() → bool
hasInputImageWidth() → bool
hasMaskImage() → bool
hasMaskImageMediaType() → bool
hasMode() → bool
hasNegativePrompt() → bool
hasNumInferenceSteps() → bool
hasProgressStride() → bool
hasPrompt() → bool
hasReportIntermediateImages() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasReturnLatents() → bool
hasScheduler() → bool
hasSeed() → 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
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